複合ルート形状取得
API名:
comb_route/line
概要:
複合ルート候補検索(comb_route/searchlist)で取得できるナビゲーションIDよりルート形状を取得します。
※この機能を利用するには別途契約が必要です。
URI:
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/comb_route/line
<API使用例>
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/comb_route/line?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&naviid=N_d3fe95bac50a5b22528912ece0556358
リクエストパラメータ
| パラメータ | 必須 | デフォルト値 | 説明 |
|---|---|---|---|
| naviid | ○ | - |
ナビゲーションID 複合ルート候補検索(comb_route/searchlist)で取得できる、1件の経路に紐づく一意のIDを指定します。 なお、取得後24時間を超えたナビゲーションIDは利用できません。 |
| datum | TOKYO |
測地系 返却される緯度経度の測地系を指定します。 |
|
| llunit | dec |
緯度経度形式 緯度経度形式を指定します。 |
出力データ
出力フォーマット
{"navi_info":{"bounds":{"sw":{"lat":35.6626369,
"lon":139.7034778},
"ne":{"lat":35.6890647,
"lon":139.7618811}},
"start_name":"出発地",
"goal_name":"目的地",
"distance":6877},
"navi_sections":[{"datatype":"walk",
"caption":"出発地",
"route_type":{"code":"2006",
"text":"敷地内通路"},
"distance":0,
"start_time":"",
"arrival_time":"",
"line":null},
{"datatype":"walk",
"caption":"建物内",
"route_type":{"code":"2006",
"text":"敷地内通路"},
"distance":79,
"start_time":"0916",
"arrival_time":"0918",
"line":[35.66301,139.7614733,35.6630683,139.7618178,....]},
{"datatype":"walk",
"caption":"建物内",
"route_type":{"code":"2006",
"text":"敷地内通路"},
"distance":21,
"start_time":"0918",
"arrival_time":"0918",
"line":[35.6626483,139.7618808,35.6626483,139.7618669, ... ]},
...]}
■共通部分
| キー名 | データ型 | 説明 | |
|---|---|---|---|
| navi_info | object | 全体の情報が入ります。 | |
| bounds | object | 全ルートが収まる矩形情報が入ります。 | |
| start_name | string | 出発地名称が入ります。 | |
| goal_name | string | 目的地名称が入ります。 | |
| distance | number | 総距離が入ります。 | |
| navi_sections | array | セクション情報のオブジェクトの配列が入ります。 | |
■各セクション情報
【徒歩セクション】
| キー名 | データ型 | 説明 | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| datatype | string | データ区分walkが入ります。 | ||||||||||||||||||||||||||||||
| caption | string |
地点名称が入ります。 データのない場合nullが入ります。 |
||||||||||||||||||||||||||||||
| route_type | object | 経路種別情報が入ります。 | ||||||||||||||||||||||||||||||
| code | string |
種別コードが入ります。
|
||||||||||||||||||||||||||||||
| text | string | 種別名称が入ります。 | ||||||||||||||||||||||||||||||
| distance | number | 距離(単位:m)が入ります。 | ||||||||||||||||||||||||||||||
| start_time | string | 出発時間(hhmm形式)が入ります。 | ||||||||||||||||||||||||||||||
| arrival_time | string | 到着時間(hhmm形式)が入ります。 | ||||||||||||||||||||||||||||||
| line | array | 形状ポリラインデータが入ります。 | ||||||||||||||||||||||||||||||
【車セクション】
| キー名 | データ型 | 説明 | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| datatype | string | データ区分carが入ります。 | ||||||||||||||||||||||||||||||
| caption | string |
地点名称が入ります。 データのない場合nullが入ります。 |
||||||||||||||||||||||||||||||
| route_type | object | 経路種別情報が入ります。 | ||||||||||||||||||||||||||||||
| code | string |
種別コードが入ります。
|
||||||||||||||||||||||||||||||
| text | string | 種別名称が入ります。 | ||||||||||||||||||||||||||||||
| distance | number | 距離(単位:m)が入ります。 | ||||||||||||||||||||||||||||||
| start_time | string | 出発時間(hhmm形式)が入ります。 | ||||||||||||||||||||||||||||||
| arrival_time | string | 到着時間(hhmm形式)が入ります。 | ||||||||||||||||||||||||||||||
| image_url | string |
交差点画像URLが入ります。 データがない場合nullが入ります。 |
||||||||||||||||||||||||||||||
| line | array | 形状ポリラインデータが入ります。 | ||||||||||||||||||||||||||||||
【電車・バスセクション】
| キー名 | データ型 | 説明 | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| datatype | string | データ区分trainが入ります。 | ||||||||||||||
| caption | string |
地点名称が入ります。 データのない場合nullが入ります。 |
||||||||||||||
| route_type | object | 経路種別情報がはいります。 | ||||||||||||||
| code | string |
種別コードが入ります。
|
||||||||||||||
| text | string | 種別名称が入ります。 | ||||||||||||||
| distance | number | 距離(単位:m)が入ります。 | ||||||||||||||
| start_time | string | 出発時間(hhmm形式)が入ります。 | ||||||||||||||
| arrival_time | string | 到着時間(hhmm形式)が入ります。 | ||||||||||||||
| dirnm | string |
方面名称が入ります。 データがない場合nullが入ります。 |
||||||||||||||
| linenm | string |
路線名称が入ります。 データがない場合nullが入ります。 |
||||||||||||||
| line | array | 形状ポリラインデータが入ります。 | ||||||||||||||
出力例
[通常出力例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/comb_route/line?if_clientid=JSZxxxxxxxxxx|xxxxx&?&naviid=N_d3fe95bac50a5b22528912ece0556358
{"navi_info":{"bounds":{"sw":{"lat":35.6626369,
"lon":139.7034778},
"ne":{"lat":35.6890647,
"lon":139.7618811}},
"start_name":"出発地",
"goal_name":"目的地",
"distance":6877},
"navi_sections":[{"datatype":"walk",
"caption":"出発地",
"route_type":{"code":"2006",
"text":"敷地内通路"},
"distance":0,
"start_time":"",
"arrival_time":"",
"line":null},
{"datatype":"walk",
"caption":"建物内",
"route_type":{"code":"2006",
"text":"敷地内通路"},
"distance":79,
"start_time":"0916",
"arrival_time":"0918",
"line":[35.66301,139.7614733,35.6630683,139.7618178,35.6630689,139.7618172,....]},
{"datatype":"walk",
"caption":"建物内",
"route_type":{"code":"2006",
"text":"敷地内通路"},
"distance":21,
"start_time":"0918",
"arrival_time":"0918",
"line":[35.6626483,139.7618808,35.6626483,139.7618669,35.6626483,139.7618692,....]},
{"datatype":"walk",
"caption":"新橋駅",
"route_type":{"code":"2008",
"text":null},
"distance":85,
"start_time":"0918",
"arrival_time":"0919",
"line":[35.6626369,139.7616442,35.6626925,139.7616442,35.6626942,139.7616422,....]},
{"datatype":"train",
"caption":"虎ノ門駅",
"route_type":{"code":"3000",
"text":"鉄道経路"},
"distance":808,
"start_time":"0917",
"arrival_time":"0919",
"dirnm":null,
"linenm":null,
"line":[35.6642906,139.7613556,35.6643794,139.7610681,35.6644814,139.7607725,....]},
{"datatype":"train",
"caption":"溜池山王駅",
"route_type":{"code":"3000",
"text":"鉄道経路"},
"distance":816,
"start_time":"0919",
"arrival_time":"0921",
"dirnm":null,
"linenm":null,
"line":[35.6669706,139.7530639,35.6671294,139.7525794,35.6672592,139.7521475,....]},
{"datatype":"train",
"caption":"赤坂見附駅",
"route_type":{"code":"3000",
"text":"鉄道経路"},
"distance":711,
"start_time":"0921",
"arrival_time":"0923",
"dirnm":"[荻窪]",
"linenm":"東京メトロ丸ノ内線",
"line":[35.6686725,139.74465,35.6702314,139.7422953,35.6707406,139.7419317,....]},
{"datatype":"train",
"caption":"四ッ谷駅",
"route_type":{"code":"3000",
"text":"鉄道経路"},
"distance":1326,
"start_time":"0924",
"arrival_time":"0926",
"dirnm":null,
"linenm":null,
"line":[35.6737833,139.7403247,35.6743056,139.7401817,35.6745183,139.740125,....]},
{"datatype":"train",
"caption":"四谷三丁目駅",
"route_type":{"code":"3000",
"text":"鉄道経路"},
"distance":924,
"start_time":"0926",
"arrival_time":"0928",
"dirnm":null,
"linenm":null,
"line":[35.6824722,139.7329544,35.6824722,139.7329544,35.6825278,139.7328636,....]},
{"datatype":"train",
"caption":"新宿御苑前駅",
"route_type":{"code":"3000",
"text":"鉄道経路"},
"distance":869,
"start_time":"0928",
"arrival_time":"0930",
"dirnm":null,
"linenm":null,
"line":[35.6846939,139.7233333,35.6843056,139.7197044,35.6843333,139.7185681,....]},
{"datatype":"train",
"caption":"新宿三丁目駅",
"route_type":{"code":"3000",
"text":"鉄道経路"},
"distance":626,
"start_time":"0930",
"arrival_time":"0932",
"dirnm":null,
"linenm":null,
"line":[35.6853308,139.7139194,35.6856111,139.7126136,35.6863517,139.710875,....]},
{"datatype":"train",
"caption":"新宿駅",
"route_type":{"code":"3000",
"text":"鉄道経路"},
"distance":419,
"start_time":"0932",
"arrival_time":"0933",
"dirnm":null,
"linenm":null,
"line":[35.6877506,139.7077056,35.689,139.704875,35.6890647,139.7045908,....]},
{"datatype":"walk",
"caption":"目的地",
"route_type":{"code":"2008",
"text":null},
"distance":195,
"start_time":"0934",
"arrival_time":"0937",
"line":[35.6878547,139.7034778,35.6877353,139.7034778,35.6875019,139.7035,....]}]}
[ルート検索に失敗した例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/comb_route/line?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&naviid=N_d3fa95bac50a5b22528912ece0556358
{"navi_info":null,
"navi_sections":[]}