出力フォーマット
{"status":{"code":"string",
"text":"string"},
"route":{"toll":number,
"invalidFee:boolean",
"distance":number,
"time":number,
"link":[{"roadType":"string",
"tollFlag":boolean,
"toll":number,
"line":{"latlon":[]},
"distance":number,
"guidance":{"guidancecode":string,
"routeName":string,
"pointName":string,
"directionName":string,
"pointflg":{"ic":boolean,
"jct":boolean,
"sa":boolean,
"pa":boolean},
"imageurl":[],
"linkID":string,
"facilityName":[{"name":string,
"type":string}],
"facilityInfo":[{"name":string,
"type":{"ic":boolean,
"jct":boolean,
"tollgate":boolean,
"sapa":boolean,
"smartic":boolean}}],
"regulation":{"height":number,
"width":number,
"weight":number},
"passagelink":boolean},...],
"detailedTime":[{"time":number,
"linkOffset":number,
"linkLength":number},...],
"passage":boolean},
}
|
キー名 |
データ型 |
説明 |
|---|
|
status |
|
|
|
|
object |
ステータス情報が入ります。 |
|
|
code |
|
|
|
string |
ステータスコードが入ります。
|
|
|
text |
|
|
|
string |
ステータス内容に関するテキスト情報が入ります。 |
|
route |
|
|
|
|
object |
ルート検索結果が入ります。 |
|
|
toll |
|
|
|
number |
下記道路種別の合計料金(円)が入ります。
自動車ルート候補一覧取得で取得した値とは一致しない場合があります。
また、経路結果に新規開通などで料金が反映されていない区間が含まれており、
一部料金が取得できない場合は合計料金として0が入ります。 |
|
|
invalidFee |
|
|
|
boolean |
算出された合計料金が無効値であったかどうかを示すフラグが入ります。
料金無効値は、経路結果に新規開通などで料金が反映されていない区間が含まれている場合に発生します。
|
true |
料金無効値があった |
|
false |
料金無効値がなかった |
|
|
|
distance |
|
|
|
number |
合計距離(メートル)が入ります。 |
|
|
time |
|
|
|
number |
合計時間(分)が入ります。
走行時間が不明な場合はNULLが入ります。 |
|
|
link |
|
|
|
array |
リンク情報の配列が入ります。 |
|
|
|
roadType |
|
|
string |
当該リンクの道路種別が入ります。 |
|
|
|
tollFlag |
|
|
boolean |
当該リンクが有料道路かどうかを示すフラグが真偽値で入ります。 |
|
|
|
toll |
|
|
number |
料金が入ります。 |
|
|
|
distance |
|
|
number |
当該リンクの距離(メートル)が入ります。 |
|
|
|
line |
|
|
object |
当該リンクの形状データが入ります。 |
|
|
|
|
latlon |
|
array |
形状ポリラインデータが入ります。 |
|
|
|
guidance |
|
|
object |
当該リンクの地点型誘導情報が入ります。
誘導情報が存在しない場合はnullが入ります。 |
|
|
|
|
guidancecode |
|
string |
右左折情報が入ります。
|
0 |
直進方向 |
|
1 |
斜め右方向 |
|
2 |
斜め左方向 |
|
3 |
右方向 |
|
4 |
左方向 |
|
5 |
右斜め方向 |
|
6 |
左斜め方向 |
|
7 |
Uターン |
|
|
|
|
|
pointName |
|
string |
交差点名称が入ります。
交差点名称の情報が存在しない場合はnullが入ります。 |
|
|
|
|
routeName |
|
string |
道路名称が入ります。
道路名称の情報が存在しない場合はnullが入ります。 |
|
|
|
|
directionName |
|
string |
方面名称が入ります。
方面名称の情報が存在しない場合はnullが入ります。 |
|
|
|
|
pointflg |
|
object |
高速道路上の施設への接続の可否が入ります。 |
|
|
|
|
|
ic |
boolean |
ICに接続可能かどうかを示すフラグが入ります。 |
|
|
|
|
|
jct |
boolean |
jctに接続可能かどうかを示すフラグが入ります。 |
|
|
|
|
|
sa |
boolean |
saに接続可能かどうかを示すフラグが入ります。 |
|
|
|
|
|
pa |
boolean |
paに接続可能かどうかを示すフラグが入ります。 |
|
|
|
|
imageurl |
|
array |
誘導画像情報が入ります。
画像が存在しない場合空配列となります。 |
|
|
|
|
|
url |
string |
画像取得URLが返却されます。 |
|
|
|
|
|
type |
string |
画像タイプが返却されます。
|
1 |
行き先看板 |
|
4 |
高速分岐図 |
|
5 |
3D交差点拡大図 |
|
7 |
交差点イメージ図(都市高速入り口画像(完結画像)) |
|
8 |
交差点イメージ図(都市高速入り口画像(継続画像)) |
|
9 |
SA・PA看板画像 |
|
10 |
料金所後方面看板 |
|
11 |
ETC |
|
|
|
|
linkID |
|
|
string |
リンクIDが入ります。 |
|
|
|
facilityName |
|
|
object |
高速道路上の施設情報が返却されます。
施設情報が存在しない場合空配列となります。
※非推奨パラメータです。facilityInfoの使用をお奨めします。 |
|
|
|
|
type |
|
string |
施設タイプが返却されます。 |
|
|
|
|
name |
|
string |
施設名称が返却されます。 |
|
|
|
facilityInfo |
|
|
array |
高速道路上の施設情報のオブジェクトが配列で返却されます。 |
|
|
|
|
name |
|
string |
施設名称が返却されます。 |
|
|
|
|
type |
|
object |
施設タイプが真偽値で返却されます。
|
ic |
ICの施設であるかどうか |
|
jct |
JCTの施設であるかどうか |
|
tollgate |
料金所の施設であるかどうか |
|
sapa |
SA/PAの施設であるかどうか |
|
smartic |
スマートICの施設であるかどうか |
|
|
|
|
regulation |
|
|
object |
道路規制情報が返却されます。 |
|
|
|
|
height |
|
number |
道路の高さ規制情報が入ります。単位(cm)
高さ規制の情報が存在しない場合はnullが入ります。 |
|
|
|
|
width |
|
number |
道路の幅の規制情報が入ります。単位(cm)
幅の規制情報が存在しない場合はnullが入ります。 |
|
|
|
|
weight |
|
number |
道路の重量規制情報が入ります。単位(kg)
重量規制の情報が存在しない場合はnullが入ります。 |
|
|
|
passagelink |
|
|
boolean |
当該リンクが高さ、幅、規制を回避できているかを示すフラグが入ります。
リクエストパラメータでheight、width、weightを指定した状態で規制を回避できない場合、規制にかかるルートを返却する場合があります。
routeID指定時の検索では、route3/drive_listで指定したheight、width、weightと同じ値を指定しないと正しい値とはなりません。
|
true |
規制がない、または規制にかからない |
|
false |
規制にかかる |
|
|
|
detailedTime |
|
|
|
array |
探索されたルートにおける、区間ごとの所要時間情報のオブジェクトが配列で入ります。 |
|
|
|
time |
|
|
number |
当該区間の所要時間が入ります。 |
|
|
|
linkOffset |
|
|
number |
当該区間が対応する出力パラメータlinkの開始リンク位置(インデックス値)が入ります。 |
|
|
|
linkLength |
|
|
number |
当該区間が対応する出力パラメータlinkの数が入ります。 |
|
|
passage |
|
|
|
boolean |
探索されたルートが高さ、幅、重量の規制を回避できているかどうかを示すフラグが入ります。
リクエストパラメータでheight、width、weightを指定した状態で規制を回避できない場合、規制にかかるルートを返却する場合があります。
routeID指定時の検索では、route3/drive_listで指定したheight、width、weightと同じ値を指定しないと正しい値とはなりません。
|
true |
回避できている |
|
false |
回避できていない |
|
出力例
[通常出力例 機能1. 自動車ルート検索]
http://core.its-mo.com/zmaps/api/apicore/core/v1_0/route3/drive?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip
&searchType=0&from=35.672830768,139.753336154&to=35.650643034,139.697293843
{"status":{"code":"0000",
"text":""},
"route":{"toll":1300,
"invalidFee":false,
"distance":5889,
"time":7,
"link":[{"roadType":"都市高速道路",
"tollFlag":true,
"toll":0,
"line":{"latlon":[35.6690722,139.7493894,...]},
"distance":87,
"guidance":{"guidancecode":null,
"routeName":null,
"pointName":null,
"directionName":null,
"pointflg":{"jc":true,
"jct":false,
"sa":false,
"ps":false},
"imageurl":[]},
"linkID":"330831",
"facilityName":[{"name":"霞が関",
"type":"IC"}],
"facilityInfo":[{"name":"霞が関"
"type":{"ic":true,
"jct":false,
"tollgate":false,
"sapa":false,
"smartic":false}}],
"regulation":{"height":null,
"width":null,
"weight":null},
"passagelink":true},
"detailedTime":[{"time": 0.01615384593606,
"linkOffset": 0,
"linkLength": 1},
{"time": 0.11547619104385,
"linkOffset": 1,
"linkLength": 1}, ...],
"passage":true}
}
[通常出力例 機能2. 自動車ルート候補詳細取得]
http://core.its-mo.com/zmaps/api/apicore/core/v1_0/route3/drive?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&routeID=THB_2aca576583926150c73bf5f999ad1ec7
{"status":{"code":"0000",
"text":""},
"route":{"toll":0,
"invalidFee":false,
"distance":257,
"time":16,
"link":[{"roadType":"一般道路(その他)",
"tollFlag":false,
"toll":0,
"line":{"latlon":[35.6251592,139.7437803,35.6250981,139.7435536]},
"distance":22,
"guidance":{"guidancecode":4,
"routeName":null,
"pointName":null,
"directionName":null,
"pointflg":{"ic":false,
"jct":false,
"sa":false,
"pa":false},
"imageurl":[]},
"linkID":2182772,
"facilityName":[],
"facilityInfo":[],
"regulation":{"height":null,
"width":null,
"weight":null},
"passagelink":true},
{"roadType":"一般道路(その他)",
"tollFlag":false,
"toll":0,
"line":{"latlon":[35.6250981,139.7435536,35.625,139.7435225]},
"distance":11,
"guidance":null,
"linkID":2185439,
"facilityName":[],
"facilityInfo":[],
"regulation":{"height":null,
"width":null,
"weight":null},
"passagelink":true},
{"roadType":"一般道路(その他)",
"tollFlag":false,
"toll":0,
"line":{"latlon":[35.625,139.7435225,35.6244811,139.7433622]},
"distance":59,
"guidance":null,
"linkID":2185438,
"facilityName":[],
"facilityInfo":[],
"regulation":{"height":null,
"width":null,
"weight":null},
"passagelink":true},
{"roadType":"一般道路(その他)",
"tollFlag":false,
"toll":0,
"line":{"latlon":[35.6244811,139.7433622,35.6239622,139.7431944]},
"distance":60,
"guidance":null,
"linkID":2185438,
"facilityName":[],
"facilityInfo":[],
"regulation":{"height":null,
"width":null,
"weight":null},
"passagelink":true},
{"roadType":"一般道路(その他)",
"tollFlag":false,
"toll":0,
"line":{"latlon":[35.6239622,139.7431944,35.6234433,139.7430267]},
"distance":60,
"guidance":null,
"linkID":2185438,
"facilityName":[],
"facilityInfo":[],
"regulation":{"height":null,
"width":null,
"weight":null},
"passagelink":true},
{"roadType":"一般道路(その他)",
"tollFlag":false,
"toll":0,
"line":{"latlon":[35.6234433,139.7430267,35.6230483,139.7428986]},
"distance":45,
"guidance":null,
"linkID":2185438,
"facilityName":[],
"facilityInfo":[],
"regulation":{"height":null,
"width":null,
"weight":null},
"passagelink":true}, ...],
"detailedTime":[{"time": 0.01615384593606,
"linkOffset": 0,
"linkLength": 1},
{"time": 0.11547619104385,
"linkOffset": 1,
"linkLength": 1}, ...],
"passage":true}
}
[ルート検索に失敗した例]
ルート検索に失敗した場合には、routeの中身がnullとなります。
from,toの直線距離が50m以下の時はルート検索に失敗します。
{"status":{"code":"0000",
"text":""},
"route":null}