ルート前後形状取得
/shape_slide [GET]
基本情報
概要
電車（航空路線、徒歩含む）を移動手段として基準経路の前後の時間の経路を検索し、その結果を形状で取得します。
※当APIをご利用の場合は、時刻表データ利用のオプション契約が別途必要となります
URL
https://{HOST}/{CID}/v1/shape_slide
※APIマーケットでは提供しておりません
出力形式
- GeoJSON
- JSON
対応言語
- ja
パラメータ
- 「ルート前後検索 /route_slide」と同等のパラメータを受け付けます
利用できないパラメータについて
本APIは以下パラメータには対応してません
・lang
- 本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」と同等のレスポンスとなります
エラー情報
エラーハンドリングについて
エラーメッセージは追加/変更/削除されることがあります。
エラーハンドリングされる場合はHTTPステータスコードをもとにご対応ください。
共通エラーについてはこちらをご参照ください。
| HTTPステータス | エラーメッセージ | 発生理由 |
|---|---|---|
| 405 | This http method is invalid : POST (等) | 許可されていないHTTPメソッドでリクエストした場合に発生します。 |
| 400 | bad usage on this contract : this api can not use without train timetable, bus timetable | 時刻表に必要なオプションが設定されていない場合に発生します。 |
| 400 | parameter error: start: required field | startパラメータが未指定の場合に発生します。 |
| 400 | parameter error: start: no definitions validate | startがJSON・交通拠点ID・座標のいずれの形式にも合致しない場合に発生します。 |
| 400 | parameter error: goal: required field | goalパラメータが未指定の場合に発生します。 |
| 400 | parameter error: goal: no definitions validate | goalがJSON・交通拠点ID・座標のいずれの形式にも合致しない場合に発生します。 |
| 400 | parameter error: start_time: required field | start_timeパラメータが未指定の場合に発生します。 |
| 400 | parameter error: start_time: not datetime format :[value] | start_timeが日時形式でない場合に発生します。 |
| 400 | parameter error: start_time: an invalid datetime:[value] | start_timeが無効な日時の場合に発生します。 |
| 400 | parameter error: train_id: required field | train_idパラメータが未指定の場合に発生します。 |
| 400 | parameter error: start_node: required field | start_nodeパラメータが未指定の場合に発生します。 |
| 400 | parameter error: start_node: an invalid code:[value] | start_nodeが無効な交通拠点IDの場合に発生します。 |
| 400 | parameter error: range: required field | rangeパラメータが未指定の場合に発生します。 |
| 400 | parameter error: range: an invalid range:[value] | rangeが無効な形式の場合に発生します。 |
| 400 | parameter error: range:[value] is too large | rangeの前後合計が10を超える場合に発生します。 |
| 400 | parameter error: basis_route: required field | basis_routeパラメータが未指定の場合に発生します。 |
| 400 | parameter error: basis_route: not json format :[value] | basis_routeがJSON形式でない場合に発生します。 |
| 400 | parameter error: walk_speed: min value is 3.0 | walk_speedが3.0未満の場合に発生します。 |
| 400 | parameter error: walk_speed: max value is 8.0 | walk_speedが8.0を超える場合に発生します。 |
| 400 | parameter error: walk_speed: ['walk_route'] must not be present with 'walk_speed' | walk_speedとwalk_routeを同時に指定した場合に発生します。 |
| 400 | parameter error: walk_route: an invalid item: [item] | walk_routeに無効な値が含まれる場合に発生します。 |
| 400 | parameter error: walk_route: ['walk_speed'] must not be present with 'walk_route' | walk_routeとwalk_speedを同時に指定した場合に発生します。 |
| 400 | parameter error: use_car: unallowed value[value] | use_carが無効な値の場合に発生します。 |
| 400 | parameter error: use_share_cycle: unallowed value[value] | use_share_cycleが無効な値の場合に発生します。 |
| 400 | parameter error: bicycle_speed: min value is 5 | bicycle_speedが5未満の場合に発生します。 |
| 400 | parameter error: bicycle_speed: max value is 132 | bicycle_speedが132を超える場合に発生します。 |
| 400 | parameter error: bicycle_speed: field 'use_share_cycle' is required | bicycle_speedを指定したがuse_share_cycleが未指定の場合に発生します。 |
| 400 | parameter error: bicycle_condition: unallowed value[value] | bicycle_conditionが無効な値の場合に発生します。 |
| 400 | parameter error: bicycle_condition: field 'use_share_cycle' is required | bicycle_conditionを指定したがuse_share_cycleが未指定の場合に発生します。 |
| 400 | parameter error: bus_data: unallowed value[value] | bus_dataが無効な値の場合に発生します。 |
| 400 | parameter error: options: unallowed value[value] | optionsが無効な値の場合に発生します。 |
| 400 | parameter error: datum: unallowed value[value] | datumが無効な値の場合に発生します。 |
| 400 | parameter error: coord_unit: unallowed value[value] | coord_unitが無効な値の場合に発生します。 |
| 400 | parameter error: coord_adjustment: unallowed value[value] | coord_adjustmentが無効な値の場合に発生します。 |
| 400 | parameter error: format: unallowed value[value] | formatが無効な値の場合に発生します。 |
| 400 | start or goal is multiple. | startまたはgoalがリスト形式の場合に発生します。 |
| 400 | coordinate or node is required | start/goalのJSON内にnode・lat・lonのいずれも含まれていない場合に発生します。 |
| 400 | parameter error: node: an invalid code:[value] | start/goalのJSON内のnodeが無効な交通拠点IDの場合に発生します。 |
| 400 | parameter error: lat: an invalid latitude:[value] | start/goalのJSON内のlatが無効な緯度の場合に発生します。 |
| 400 | parameter error: lat: depends on these values: | start/goalのJSON内でlatのみ指定しlonが未指定の場合に発生します。 |
| 400 | parameter error: lon: an invalid longitude:[value] | start/goalのJSON内のlonが無効な経度の場合に発生します。 |
| 400 | parameter error: lon: depends on these values: | start/goalのJSON内でlonのみ指定しlatが未指定の場合に発生します。 |
| 400 | basis_route must be in array format | basis_routeがリスト形式でない場合に発生します。 |
| 400 | list size is too small | basis_routeのリストが空の場合に発生します。 |
| 400 | parameter error: start: required field | basis_route内のstartが未指定の場合に発生します。 |
| 400 | parameter error: start: an invalid code:[value] | basis_route内のstartが無効な交通拠点IDの場合に発生します。 |
| 400 | parameter error: goal: required field | basis_route内のgoalが未指定の場合に発生します。 |
| 400 | parameter error: goal: an invalid code:[value] | basis_route内のgoalが無効な交通拠点IDの場合に発生します。 |
| 400 | parameter error: link: required field | basis_route内のlinkが未指定の場合に発生します。 |
| 400 | parameter error: link: an invalid code:[value] | basis_route内のlinkが無効な交通拠点IDの場合に発生します。 |
| 400 | parameter error: direction: required field | basis_route内のdirectionが未指定の場合に発生します。 |
| 400 | parameter error: direction: unallowed value[value] | basis_route内のdirectionが無効な値の場合に発生します。 |
| 400 | use_share_cycle can not use | use_share_cycle=true指定時にシェアサイクル設定がない場合に発生します。 |
| 400 | bicycle_condition or bicycle_speed can not use | use_share_cycle=false指定時にbicycle_conditionまたはbicycle_speedを指定した場合に発生します。 |
| 400 | bad usage on this contract : bus_data | bus_data=timetable指定時に必要なオプションが設定されていない場合に発生します。 |