ルート前後検索
/route_slide [GET]
基本情報
概要
電車（航空路線、徒歩含む）を移動手段として、基準経路の前後の時間の経路を検索します。
※経由地の指定はできません
※当APIをご利用の場合は、時刻表データ利用のオプション契約が別途必要となります
URL
https://{HOST}/{CID}/v1/route_slide
※APIマーケットでは提供しておりません
出力形式
- JSON
- GeoJSON
対応言語
- ja, en, ko, zh-CN, zh-TW, th
出力順
- 出発時刻の昇順
パラメータ
| パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
|---|---|---|---|---|---|---|
| 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) | 数値 | 4.8 | 最小値：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指定時のみ有効 | |
| commuter_pass | 定期券区間指定 | 定期区間のJSON表現（配列） | 最大10区間まで | 以下の場合は定期券区間を指定しても無効になります ・walk_routeの値にavoid_stepもしくはavoid_escalatorを指定した場合 ・新幹線を利用する場合 ・定期券区間が300kmを超える場合 詳細はこちらをご覧ください |
||
| bus_data | バスの利用データ | 文字列 | none | none：バス時刻表利用なし timetable：バス時刻表利用あり |
バス時刻表を利用する場合はオプション契約が別途必要となります | |
| options | 追加出力情報 | 文字列 | railway_calling_at：乗換の途中駅情報 bus_commuter_pass：バス定期券情報 congestion：混雑度情報 |
バス定期券情報はバスデータ利用時のみ指定可能 混雑度情報は時刻表データ利用時のみ指定可能 混雑度情報の詳細はこちらをご覧ください |
||
| shape | 形状出力 | 真偽値 | false | true false |
trueを指定時にはshapes(ルート形状)が出力されます | |
| shape_color | 経路形状の色分け | 文字列 | railway_line：鉄道路線毎の線色を使用 | |||
| datum | 緯度経度の測地系 | 文字列 | wgs84 | wgs84：世界測地系 tokyo：旧日本測地系 |
||
| coord_unit | 出力データに含まれる緯度経度の単位 | 文字列 | degree | degree：度表記の10進法 millisec：ミリ秒表記 |
||
| lang | 言語 | 文字列 | ja: 日本語 en: 英語 ko: 韓国語 zh-CN: 中国語(簡体字) zh-TW: 中国語(繁体字) th: タイ語 |
出力する言語を指定します ※多言語オプション申込時のみ利用可能 (APIマーケットでは利用不可) |
パラメータの指定について
「ルート検索（トータルナビ） /route_transit」の出力結果から抽出した項目を指定してください。
/route_transitの出力結果にself_idが複数存在する場合は、1つ目のself_idをtrain_idに指定してください。
start_timeには、基準となる出発ノードIDに対する時刻を指定してください。
use_car及びuse_share_cycleの指定について
車及びシェアサイクルのルートを出力する際は、下記の区間を考慮します。
・出発地から目的地
・出発地から出発駅
・目的駅から目的地
混雑度情報について
混雑度情報の対象は、平日のみとなります。
下記の各路線(首都圏)に対応しています。
【JR】
川越線、京浜東北線、京葉線、埼京線、湘南新宿ライン、常磐線、総武線快速、総武線各停、外房線、高崎線、中央線、東海道線、東北本線、南武線、根岸線、武蔵野線、山手線、横須賀線、横浜線
【地下鉄】
銀座線、千代田線、東西線、南北線、半蔵門線、日比谷線、副都心線、丸ノ内線、有楽町線、都営浅草線、都営大江戸線、都営新宿線、都営三田線
【私鉄】
小田急小田原線、小田急多摩線、小田急江ノ島線、京王線、京王相模原線、京王井の頭線、京王新線、京急本線、京成本線、京成押上線、京成成田空港線、北総鉄道線、東葉高速線、埼玉高速鉄道、西武新宿線、西武池袋線、西武有楽町線、相鉄本線、相鉄いずみ野線、つくばエクスプレス、東急東横線、東急目黒線、東急田園都市線、東急大井町線、東急池上線、東急多摩川線、東京モノレール、東武伊勢崎線、東武東上線、日暮里舎人ライナー、みなとみらい線、ゆりかもめ、りんかい線、京急空港線
地点の 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：下り |
定期区間の JSON 表現
| プロパティ名 | 必須 | 概要 | 型名 | デフォルト値 | 備考 |
|---|---|---|---|---|---|
| start | ✔ | 定期区間の出発駅ID | 文字列 | ||
| goal | ✔ | 定期区間の到着駅ID | 文字列 | ||
| link | ✔ | 路線ID | 文字列 | ||
| direction | (✔) | 進行方向 | 文字列 | up：上り down：下り 下記の表に記載がある環状線を用いる場合のみ必須パラメータとなります。 |
環状線における direction (進行方向) の指定方法について
環状線を定期券区間として指定する場合の進行方向パラメータは、当社が定義した区分に基づいて
指定していただく必要があります。具体的には以下の通りです。
| link（路線ID） | 路線名 | directionにupを指定した場合 | directionにdownを指定した場合 | 備考 |
|---|---|---|---|---|
| 00000082 | ＪＲ大阪環状線 | 外回り | 内回り | |
| 00000141 | JR山手線 | 内回り | 外回り | |
| 00000250 | 伊予鉄道１・２系統 | 左回り | 右回り | |
| 00000668 | 札幌市電山鼻線 | 外回り | 内回り | |
| 00000674 | 山万ユーカリが丘線 | 左回り | 環状部のみ片方向 | |
| 00000704 | 神戸新交通ポートアイランド線 | 左回り | 環状部のみ片方向 | |
| 00000792 | 都営大江戸線（環状部） | 左回り | 右回り | |
| 00000859 | 名古屋市営名城線 | 右回り | 左回り | |
| 00000909 | ディズニーリゾートライン | 左回り | 片方向 | |
| 00001162 | 富山地方鉄道環状線 | 右回り | 左回り |
定期区間を指定した際の挙動について
【出力順】
・定期券区間を指定した場合は「定期券区間をより多く通っている経路」から出力されます
（その他の順番で出力したい場合はorderパラメータをご利用ください）
【制限】
・必ずしも定期区間を通る経路が出るわけではありません
・300kmを超える定期券区間、新幹線を利用した定期券区間を指定した場合は指定した定期券区間が無効になります
進行方向（direction）の指定について
誤った進行方向を指定した場合、ルート検索時に定期券区間を正しく考慮することができません。
※特に環状線は進行方向により定期券区間が変わってしまう可能性があるため、意図しない定期券区間を考慮してしまうことがあります。
定期券区間指定パラメータ（commuter_pass）にて進行方向を指定する場合は正しい進行方向を指定した上で検索していただきますよう、お願い致します。
新幹線の経路を含む定期券運賃出力の制限事項
新幹線の経路を含む定期券運賃出力の制限事項
・北海道新幹線とJR東日本の在来線をまたいで利用する場合、実際の金額より少ない金額が出力される可能性があります。
・全車指定席の列車では新幹線定期券運賃が出力されません。
・並行する在来線を折返し乗車する場合、実際の金額より多い金額が出力される場合があります。
パラメータ構成例
・出発駅：東京駅、到着駅：千葉駅、出発時刻：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」と同等のレスポンスとなります
-
基準経路を含む複数の経路が出力されます
エラー情報
エラーハンドリングについて
エラーメッセージは追加/変更/削除されることがあります。
エラーハンドリングされる場合はHTTPステータスコードをもとにご対応ください。
共通エラーについてはこちらをご参照ください。
| HTTPステータス | エラーメッセージ | 発生理由 |
|---|---|---|
| 405 | This http method is invalid : POST (等) | 許可されていないHTTPメソッドでアクセスされた場合に発生します。 |
| 400 | parameter error: start: ['required field'] | 必須パラメータである start が指定されていない、または空文字の場合に発生します。 |
| 400 | parameter error: start: ['no definitions validate', {'anyof definition 0': ['not json format : {value}'], 'anyof definition 1': ['an invalid code: {value}'], 'anyof definition 2': ['an invalid coordinate : {value}']}] | start に指定した値のフォーマットが不正、または正しくない文字列が含まれている場合に発生します。 |
| 400 | parameter error: {field}: ['{error}'] ※field は lat, lon, node, spot 等 | start をJSON形式で指定した場合に、内部フィールドの値が不正な場合に発生します。 |
| 400 | parameter error: goal: ['required field'] | 必須パラメータである goal が指定されていない、または空文字の場合に発生します。 |
| 400 | parameter error: goal: ['no definitions validate', {'anyof definition 0': ['not json format : {value}'], 'anyof definition 1': ['an invalid code: {value}'], 'anyof definition 2': ['an invalid coordinate : {value}']}] | goal に指定した値のフォーマットが不正、または正しくない文字列が含まれている場合に発生します。 |
| 400 | parameter error: {field}: ['{error}'] ※field は lat, lon, node, spot 等 | goal をJSON形式で指定した場合に、内部フィールドの値が不正な場合に発生します。 |
| 400 | parameter error: start_time: ['required field'] | 必須パラメータである 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: train_id: ['empty values not allowed'] | train_id に空文字を指定した場合に発生します。 |
| 400 | parameter error: start_node: ['required field'] | 必須パラメータである start_node が指定されていない場合に発生します。 |
| 400 | parameter error: start_node: ['an invalid code: {value}'] | start_node に不正なノードID（8桁数字以外）を指定した場合に発生します。 |
| 400 | parameter error: range: ['required field'] | 必須パラメータである range が指定されていない場合に発生します。 |
| 400 | parameter error: range: ['an invalid range: {value}'] | range に不正な形式の値を指定した場合に発生します（許可形式: 単一数値 -10〜10、またはアンダースコア区切り N_N で合計10以下）。 |
| 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: ['max value is 8.0'] | walk_speed に数値以外の文字列を指定した場合や、下限値（3.0未満）や上限値（8.0超過）の範囲外の値を指定した場合に発生します。 |
| 400 | parameter error: walk_speed: ["'walk_route' must not be present with 'walk_speed'"], walk_route: ["'walk_speed' must not be present with 'walk_route'"] | walk_speed と walk_route を同時に指定した場合に発生します。 |
| 400 | parameter error: walk_route: ['an invalid item: {value}'] | walk_route に許可されていない値を指定した場合に発生します（許可値: avoid_step, avoid_escalator, avoid_rain, babycar）。 |
| 400 | parameter error: use_car: ['unallowed value {value}'] | use_car に true, false 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: use_share_cycle: ['unallowed value {value}'] | use_share_cycle に true, false 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: bicycle_speed: ['min value is 5'] または bicycle_speed: ['max value is 132'] | bicycle_speed に数値以外の文字列を指定した場合や、下限値（5未満）や上限値（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 に許可されていない値を指定した場合に発生します（許可値: recommend, total_distance, low_pitched, high_pitched, main_street, back_street, cycling_road）。 |
| 400 | parameter error: bicycle_condition: ["field 'use_share_cycle' is required"] | bicycle_condition を指定しているが、use_share_cycle が指定されていない場合に発生します。 |
| 400 | parameter error: special_pass: ['an invalid item: {value}'] | special_pass に許可されていない特別パスIDを指定した場合に発生します。 |
| 400 | parameter error: suggest_special_pass: ['an invalid item: {value}'] | suggest_special_pass に許可されていない値を指定した場合に発生します。 |
| 400 | parameter error: bus_data: ['unallowed value {value}'] | bus_data に none, timetable 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: commuter_pass: ['not json format : {value}'] | commuter_pass に不正なJSON文字列を指定した場合に発生します。 |
| 400 | parameter error: consider_commuter_pass: ['unallowed value {value}'] | consider_commuter_pass に true, false 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: consider_commuter_pass: ["field 'commuter_pass' is required"] | consider_commuter_pass を指定しているが、commuter_pass が指定されていない場合に発生します。 |
| 400 | parameter error: options: ['an invalid item: {value}'] | options に許可されていない値を指定した場合に発生します（許可値: railway_calling_at, bus_commuter_pass, congestion）。 |
| 400 | parameter error: shape: ['unallowed value {value}'] | shape に true, false 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: shape_color: ['unallowed value {value}'] | shape_color に railway_line 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: datum: ['unallowed value {value}'] | datum に wgs84, tokyo 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: coord_unit: ['unallowed value {value}'] | coord_unit に degree, millisec 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: lang: ['unallowed value {value}'] | lang に ja, en, ko, zh-CN, zh-TW, th 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: coord_adjustment: ['unallowed value {value}'] | coord_adjustment に true, false 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: use_on_demand_bus: ['unallowed value {value}'] | use_on_demand_bus に true, false 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: commuter_pass_exclude_superexpress: ['unallowed value {value}'] | commuter_pass_exclude_superexpress に true, false 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: {field}: ['{error}'] ※field は start, goal, link, direction | basis_route の各要素内のフィールドの値が不正な場合に発生します。 |
| 400 | parameter error: {field}: ['{error}'] ※field は start, goal, link, direction | commuter_pass の各要素内のフィールドの値が不正な場合に発生します。 |
| 400 | coordinate or node is required | start または goal をJSON形式で指定したが、lat/lon/node のいずれも含まれていない場合に発生します。 |
| 400 | start or goal is multiple. | start または goal に配列形式を指定した場合に発生します。route_slide は複数地点指定に対応していません。 |
| 400 | basis_route must be in array format | basis_route が JSON 配列ではない場合に発生します。 |
| 400 | list size is too small | basis_route または commuter_pass の配列が空（要素数0）の場合に発生します。 |
| 400 | list size is too large | commuter_pass の配列件数が 10 件を超えた場合に発生します。 |
| 400 | avoid_step and avoid_escalator can not use with commuter_pass | commuter_pass と walk_route=avoid_step または avoid_escalator を併用した場合に発生します。 |
| 400 | direction required. | commuter_pass で環状線リンクを指定したのに 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 : this api can not use without train timetable, bus timetable | 契約上、電車時刻表とバス時刻表が利用設定されていない場合に発生します。 |
| 400 | bad usage on this contract : bus_data | bus_data=timetableを指定したが契約上バス時刻表が利用設定されていない場合に発生します。 |
| 400 | bad usage on this contract : congestion must be used with train_data | options=congestion を指定したが、契約上電車時刻表オプションが有効化されていない場合に発生します。 |
| 400 | bad usage on this contract : Multilingual | lang パラメータを指定したが、契約上多言語オプションが有効化されていない場合に発生します。 |