ルート前後形状取得
/shape_slide [GET]
基本情報
概要
電車（航空路線、徒歩含む）を移動手段として基準経路の前後の時間の経路を検索し、その結果を形状で取得します。
※当APIをご利用の場合は、時刻表データ利用のオプション契約が別途必要となります
URL
https://{HOST}/{CID}/v1/shape_slide
※APIマーケットでは提供しておりません
出力形式
- GeoJSON
- JSON
対応言語
- ja
パラメータ
- 「ルート前後検索 /route_slide」と同等のパラメータを受け付けます
- 本API独自のパラメータは以下の通りです
| パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
|---|---|---|---|---|---|---|
| options | 追加出力情報 | 文字列 | transport_shape：公共交通路線形状 | transport_shapeを指定しても、路線形状が存在しない場合は形状情報が出力されません | ||
| no | 経路番号 | 数値 | 複数経路が返却される際に、1つの経路を特定する必要があります 出力する経路番号を指定します 未指定の場合は一番最初の経路が選択されます |
|||
| format | 出力形式 | 文字列 | geojson | geojson：GeoJSON 形式 json：JSON 形式 |
徒歩＋公共交通機関のルートの場合、'options=transport_shape'を付与しないと徒歩ルートの形状のみが出力されます。
公共交通機関のみの乗換ルートの場合、'options=transport_shape'を付与しないと形状情報が出力されません。
フォーマットについて
GeoJSON は地理形状を表現する一般的なフォーマットです。
GeoJSON形式の出力結果は、/map_script で利用できます。
JSON形式の出力結果は、/map_image で利用できます。
パラメータ構成例（GeoJSONの場合）
・出発駅：東京駅、到着駅：千葉駅、出発時刻：2019年10月1日8時の1本後のルート形状をGeoJSONで取得（路線形状付き）
/shape_slide?start=00006668&goal=00005172&start_node=00006668&train_id=808e0191&range=1&format=geojson&options=transport_shape&start_time=2019-10-01T08:00:00&basis_route=[{"start":"00006668","goal":"00005172","link":"00000168","direction":"down"}]
パラメータ構成例（JSONの場合）
・出発駅：東京駅、到着駅：千葉駅、出発時刻：2019年10月1日8時の1本後のルート形状をJSONで取得（路線形状付き）
/shape_slide?start=00006668&goal=00005172&start_node=00006668&train_id=808e0191&range=1&format=json&options=transport_shape&start_time=2019-10-01T08:00:00&basis_route=[{"start":"00006668","goal":"00005172","link":"00000168","direction":"down"}]
JSON 表現は URL エンコードをした上でリクエストしてください
レスポンス（GeoJSON/JSON）
- 「ルート形状取得（トータルナビ） /shape_transit」と同等のレスポンスとなります