ルート前後検索
/route_slide [GET]
基本情報
概要
電車（航空路線、徒歩含む）を移動手段として、基準経路の前後の時間の経路を検索します。
※経由地の指定はできません
※当APIをご利用の場合は、時刻表データ利用のオプション契約が別途必要となります
URL
https://{HOST}/{CID}/v1/route_slide
※Rakuten RapidAPIでは提供しておりません
出力形式
- JSON
対応言語
- ja
出力順
- 出発時刻の昇順
パラメータ
| パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
|---|---|---|---|---|---|---|
| start | ✔ | 出発地点 | 地点のJSON表現 文字列（ノードID） カンマ区切りの数値（緯度,経度） |
|||
| goal | ✔ | 到着地点 | 地点のJSON表現 文字列（ノードID） カンマ区切りの数値（緯度,経度） |
|||
| start_time | ✔ | 出発時刻 | 文字列（日付時刻） YYYY-MM-DDThh:mm:ss |
時刻の指定例 2019-09-26T08:00:00 出発ノードIDの時刻を指定してください |
||
| train_id | ✔ | 基準となる列車ID | 文字列 | /route_transitのレスポンス項目「self_id」の値を指定してください | ||
| start_node | ✔ | 基準となる出発ノードID | 文字列 | |||
| range | ✔ | 範囲指定 | 数値(整数、またはアンダースコアで繋いだ非負の2つの整数) | 正数：N本後 負数：N本前 N_Mの形式：N本前からM本後 |
前後合わせて10本までの指定が可能です 0を指定した場合はエラーとなります |
|
| basis_route | ✔ | 基準経路 | 基準経路のJSON表現（配列） | |||
| walk_route | 徒歩の利用ルート指定 | 文字列 | avoid_step：階段回避ルート avoid_escalator：階段とエスカレータ回避ルート avoid_rain：雨に濡れにくいルート babycar：ベビーカーが通れるルート |
未指定の場合は推奨ルートを使用します ピリオド区切りで複数指定可能です walk_speedを指定した場合はエラーとなります |
||
| walk_speed | 徒歩の速度(単位：km/h) | 数値 | 5 | 最小値：3.0 最大値：8.0 |
小数値は第一位まで有効です walk_routeを指定した場合はエラーとなります |
|
| use_car | 車の利用有無 | 真偽値 | false | - true：車を使う - false：車を使わない |
詳細は下記をご参照ください | |
| use_share_cycle | シェアサイクルの利用有無 | 真偽値 | false | - true：シェアサイクルを使う - false：シェアサイクルを使わない |
詳細は下記をご参照ください ※時刻表データ利用時のみ指定可能 |
|
| bicycle_speed | 自転車の速度(単位：km/h) | 整数値（時速） | 15 | 最小値：5 最大値：132 |
use_share_cycle指定時のみ有効 | |
| bicycle_condition | 自転車ルート検索の優先考慮事項 | 文字列 | recommend | recommend：推奨 total_distance：距離が短い low_pitched：坂道が少ない high_pitched：坂道が多い main_street：大通り優先 back_street：裏通り優先 cycling_road：サイクリングロード優先 |
use_share_cycle指定時のみ有効 | |
| bus_data | バスの利用データ | 文字列 | none | none：バス時刻表利用なし timetable：バス時刻表利用あり |
バス時刻表を利用する場合はオプション契約が別途必要となります | |
| options | 追加出力情報 | 文字列 | railway_calling_at：乗換の途中駅情報 | |||
| datum | 緯度経度の測地系 | 文字列 | wgs84 | wgs84：世界測地系 tokyo：旧日本測地系 |
||
| coord_unit | 出力データに含まれる緯度経度の単位 | 文字列 | degree | degree：度表記の10進法 millisec：ミリ秒表記 |
パラメータの指定について
「ルート検索（トータルナビ） /route_transit」の出力結果から抽出した項目を指定してください。
/route_transitの出力結果にself_idが複数存在する場合は、1つ目のself_idをtrain_idに指定してください。
start_timeには、基準となる出発ノードIDに対する時刻を指定してください。
use_car及びuse_share_cycleの指定について
車及びシェアサイクルのルートを出力する際は、下記の区間を考慮します。
・出発地から目的地
・出発地から出発駅
・目的駅から目的地
地点の JSON 表現
| プロパティ名 | 必須 | 概要 | 型名 | デフォルト値 | 備考 |
|---|---|---|---|---|---|
| lat | (✔) | 緯度 | 数値 | ||
| lon | (✔) | 経度 | 数値 | ||
| node | (✔) | 駅/連絡バス停ID | 文字列 | ||
| name | 地点名称 | 文字列 |
地点のJSON表現における必須項目の指定方法について
lat, lon, nodeがすべて指定されている場合は、nodeが優先されます。
latを指定した場合は、lonも必ず指定してください。
lonを指定した場合は、latも必ず指定してください。
lat, lonの指定がない場合は、nodeが必須となります。
基準経路の JSON 表現
| プロパティ名 | 必須 | 概要 | 型名 | デフォルト値 | 備考 |
|---|---|---|---|---|---|
| start | ✔ | 出発ノードID | 文字列 | ||
| goal | ✔ | 到着ノードID | 文字列 | ||
| link | ✔ | 路線ID | 文字列 | ||
| direction | ✔ | 進行方向 | 文字列 | up：上り down：下り |
パラメータ構成例
・出発駅：東京駅、到着駅：千葉駅、出発時刻：2019年10月1日8時、3本後までを出力
/route_slide?start=00006668&goal=00005172&start_time=2019-10-01T08:00:00&start_node=00006668&train_id=808e0191&range=3&basis_route=[{"start":"00006668","goal":"00005172","link":"00000168","direction":"down"}]
JSON 表現は URL エンコードをした上でリクエストしてください
レスポンス
-
「ルート検索（トータルナビ） /route_transit」と同等のレスポンスとなります
-
基準経路を含む複数の経路が出力されます