朝ラッシュ時間のルート検索(トータルナビ)
/route_transit_rush_hour [GET]
基本情報
概要
電車(徒歩含む)を移動手段として、2地点間のルートを異なる時間帯で検索します。
対象の時間帯は朝ラッシュの時間帯と平日の日中の2種類です。
URL
https://{HOST}/{CID}/v1/route_transit_rush_hour
※APIマーケットでは提供しておりません
出力形式
- JSON
対応言語
- ja, en, ko, zh-CN, zh-TW, th
パラメータ
| パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
|---|---|---|---|---|---|---|
| start | ✔ | 出発地点 | ・地点のJSON表現 ・文字列(ノードID) ・カンマ区切りの数値(緯度,経度) |
ノードIDの指定例:00007820(表参道駅) | ||
| goal | ✔ | 到着地点 | ・地点のJSON表現 ・文字列(ノードID) ・カンマ区切りの数値(緯度,経度) |
|||
| via | 経由地 | 地点のJSON表現(配列) | 経由地指定の上限数は10地点です | |||
| via_type | 経由地巡回モード | 文字列 | specified | specified: 指定順 optimal: 最適順 |
指定した経由地をどのように巡回するかを指定します | |
| unuse | 利用しない公共移動手段 | 文字列 | ピリオド区切りで複数指定可能です 詳細はこちらをご確認ください |
|||
| walk_speed | 徒歩の速度(単位:km/h) | 数値 | 4.8 | 最小値:3.0 最大値:8.0 |
小数値は第一位まで有効です | |
| datum | 緯度経度の測地系 | 文字列 | wgs84 | wgs84:世界測地系 tokyo:旧日本測地系 |
||
| coord_unit | 出力データに含まれる緯度経度の単位 | 文字列 | degree | degree:度表記の10進法 millisec:ミリ秒表記 |
||
| lang | 言語 | 文字列 | ja: 日本語 en: 英語 ko: 韓国語 zh-CN: 中国語(簡体字) zh-TW: 中国語(繁体字) th: タイ語 |
出力する言語を指定します ※多言語オプション申込時のみ利用可能 |
unuse(公共移動手段・利用しないもの)
'unuse' は以下の文字列を取り得ます。
| 文字列 | 概要 | 備考 |
|---|---|---|
| ferry | フェリー | フェリーの情報取得は、オプション機能のため、別途契約が必要となります |
| superexpress_train | 新幹線 | |
| sleeper_ultraexpress | 寝台特急 | 寝台料金を必要とする列車(例:サンライズ出雲) |
| ultraexpress_train | 特急 | 特急料金を必要とする列車(例:ふじさん、スカイライナー) |
| express_train | 急行 | 急行料金を必要とする列車(例:秩父路、もりよし) |
| rapid_train | 快速 | 運賃のみで乗車可能な速達列車(例:エアポート、JR東海道本線快速[アクティー]) |
| semiexpress_train | 有料列車 | 乗車整理券・ライナー券や座席整理券を必要とする列車 または全席指定の快速/普通列車など、急行以上を除く料金を必須とする列車(例:ホームライナー、TJライナー(有料区間のみ)) |
| local_train | 普通列車 | 運賃のみで乗車可能な列車 |
地点の JSON 表現
| プロパティ名 | 必須 | 概要 | 型名 | デフォルト値 | 備考 |
|---|---|---|---|---|---|
| lat | (✔) | 緯度 | 数値 | ||
| lon | (✔) | 経度 | 数値 | ||
| node | (✔) | 駅ID | 文字列 | ||
| name | 地点名称 | 文字列 | |||
| stay-time | 経由地の滞在時間(単位:分) | 数値 | 最小値:0 最大値:300 経由地を指定する場合のみ使用可能です |
地点のJSON表現における必須項目の指定方法について
lat, lon, nodeがすべて指定されている場合は、nodeが優先されます。
latを指定した場合は、lonも必ず指定してください。
lonを指定した場合は、latも必ず指定してください。
lat, lonの指定がない場合は、nodeが必須となります。
経由地の指定方法について
経由地の数だけ地点のJSON表現を配列にして記述します。経由地が1点の場合でも配列表現が必要です。
経由地が1点の場合の記述例は以下の通りです。
緯度経度で指定する場合 via=[{"lat":35.654043,"lon":139.729466}]、ノードIDで指定する場合 via=[{"node":"00006668"}]
最適順ルートを求める場合、経由地は2地点以上登録する必要があります。
経由地指定の上限数は10地点です。出発地点、到着地点は含みません。10地点以上の経由地を指定するとエラーとなります。
新幹線の経路を含む定期券運賃出力の制限事項
新幹線の経路を含む定期券運賃出力の制限事項
・北海道新幹線とJR東日本の在来線をまたいで利用する場合、実際の金額より少ない金額が出力される可能性があります。
・全車指定席の列車では新幹線定期券運賃が出力されません。
・並行する在来線を折返し乗車する場合、実際の金額より多い金額が出力される場合があります。
パラメータ構成例
・出発駅:東京駅、目的駅:千葉駅のルートを出力
/route_transit_rush_hour?start=00008598&goal=00004302
JSON 表現は URL エンコードをした上でリクエストしてください
レスポンス
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 移動情報の概要 | outline | Outlineオブジェクト | ||
| ラッシュ時間帯のルート情報 | rush_hour | Routeオブジェクト | ルートに関する情報のまとまり | |
| 日中のルート情報 | daytime | Routeオブジェクト | ルートに関する情報のまとまり | |
| 単位情報 | unit | Unitオブジェクト | 出力される単位の情報 |
Outlineオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| ラッシュ時間帯 | rush_hour | OutlineItemオブジェクト | ||
| 日中 | daytime | OutlineItemオブジェクト |
OutlineItemオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 所要時間 | time | 数値 | ||
| 乗換回数 | transit_count | 数値 | ||
| 利用する路線名のリスト | transport_links | 文字列 | 〇 |
Routeオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 経路の概要 | summary | RouteSummaryオブジェクト | 経路の概要に関する情報のまとまり | |
| 地点間の移動方法 | sections | RouteSectionItemオブジェクト | 〇 | 地点間の移動に関する情報のまとまり |
RouteSummaryオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 出発地点 | start | RouteSummaryItemオブジェクト 地点情報 |
出発地点に関する情報 | |
| 到着地点 | goal | RouteSummaryItemオブジェクト 地点情報 |
到着地点に関する情報 | |
| 移動情報 | move | RouteSummaryItemオブジェクト 移動情報 |
||
| 経由地 | via | RouteSummaryItemオブジェクト 地点情報 |
〇 | 経由地指定時のみ出力 |
RouteSummaryItemオブジェクト(type=point:地点情報)
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| タイプ | type | 文字列 | 常に'point'が入る | |
| 緯度経度 | coord | Coordinateオブジェクト | ||
| 地点名称 | name | 文字列 | 'start'または'goal'という文字列、または リクエストパラメータにて入力された地点情報のJSONにおけるnameの値 ノードIDを指定した場合は駅名 langパラメータを指定した場合、指定言語の翻訳値が出力される 翻訳できない場合はリクエストパラメータにて入力された値または日本語の値が出力される |
|
| 駅ID | node_id | 文字列 | 駅を識別するID | |
| 交通機関タイプの一覧 | node_types | 文字列 | 〇 | 駅を識別する種別 |
RouteSummaryItemオブジェクト(type=move:移動情報)
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 乗換回数 | transit_count | 数値 | ||
| 徒歩の距離(単位:m) | walk_distance | 数値 | 徒歩移動がある場合のみ出力 電車乗り継ぎの徒歩移動は含まない |
|
| 料金 | fare | Fareオブジェクト | 運賃がある場合のみ出力 | |
| 種別 | type | 文字列 | 常に'move'が入る | |
| 総移動時間(単位:分) | time | 数値 | ||
| 移動距離(単位:m) | distance | 数値 | ||
| 移動手段の一覧 | move_types | 文字列 | 〇 | RouteSectionItemオブジェクト(move)に存在するmoveを一覧で取得 アルファベット順で重複なしで出力 |
通勤定期券運賃の総額について
通勤定期券運賃の総額が計算可能な場合はRouteSummaryItemオブジェクト(type=move)のfareに以下のレスポンスを出力します。
総額は各区間(RouteSectionItemオブジェクト)に出力されている料金を合算した値となります。
・unit_128_train: 1ヶ月通勤定期券運賃の総額
・unit_130_train: 3ヶ月通勤定期券運賃の総額
・unit_133_train: 6ヶ月通勤定期券運賃の総額
※ルート全体に通勤定期券運賃が存在しない場合は、通勤定期券運賃の総額は出力しません。
※通勤定期券運賃の総額についての注意点・制限事項については、運賃計算結果の見方についてのページをご確認ください。
【例】下記2つの移動区間があるルートの場合
移動区間1 : 1ヶ月通勤定期券運賃と3ヶ月通勤定期券運賃が存在
移動区間2 : 1ヶ月通勤定期券運賃のみ存在
この例の場合は、ルート全体の総額が計算可能な通勤定期券運賃は1ヶ月通勤定期券運賃のみとなるため、1ヶ月通勤定期券運賃の総額のみ出力します。
RouteSectionItemオブジェクト(type=point:地点間の地点情報)
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| タイプ | type | 文字列 | 常に'point'が入る | |
| 地点の緯度経度 | coord | Coordinateオブジェクト | 出発地点または到着地点の緯度経度が出力される | |
| 地点の名称 | name | 文字列 | 'start'または'goal'という文字列、または リクエストパラメータにて入力された地点情報のJSONにおけるnameの値 ノードIDを指定した場合は駅名 langパラメータを指定した場合、指定言語の翻訳値が出力される 翻訳できない場合はリクエストパラメータにて入力された値または日本語の値が出力される |
|
| 駅ID | node_id | 文字列 | 駅を識別するID | |
| 交通機関タイプの一覧 | node_types | 文字列 | 〇 | 駅を識別する種別 |
| 経由地フラグ | with_via | 真偽値 | 地点が指定した経由地である場合に出力 | |
| 経由地点の滞在時間 | stay_time | 数値 | 地点が指定した経由地である場合に出力 | |
| 出入口の名称 | gateway | 文字列 | 出入り口情報がある場合のみ出力 langパラメータを指定した場合、指定言語の翻訳値が出力される 翻訳出来ない場合は日本語で出力される |
|
| 駅ナンバリング情報 | numbering | RouteNodeNumberオブジェクト | 駅ナンバリングに対応した駅のみ出力 |
RouteSectionItemオブジェクト(move:地点間の移動情報)
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| タイプ | type | 文字列 | 常に'move'が入る | |
| 次の地点で乗換が必要かのフラグ | next_transit | 真偽値 | 以下のケースでは出力されない 乗換が不要な場合 直通運転が存在する場合 最後のRouteItem[type=move]の時 |
|
| 利用する公共交通機関の詳細情報 | transport | Transportオブジェクト | 公共交通機関を利用しない場合は出力されない | |
| 移動手段 | move | 文字列 | ||
| 総移動時間(単位:分) | time | 数値 | type=point間の移動時間 | |
| 移動距離(単位:m) | distance | 数値 | type=point間の移動距離 | |
| 区間の路線情報 | line_name | 文字列 | 電車の場合は路線名、徒歩の場合は「"徒歩"」を出力 langパラメータを指定した場合、指定言語の翻訳値が出力される 翻訳出来ない場合は日本語で出力される 路線名称を表示する場合の優先順位についてはこちらをご覧ください |
|
| 乗換時間(単位:秒) | transfer_seconds | 数値 |
move(移動手段の一覧)
'move' は以下の文字列を取り得ます。
| 文字列 | 概要 | 備考 |
|---|---|---|
| walk | 徒歩 | |
| car | 車 | |
| bicycle | 自転車 | |
| ferry | フェリー | フェリー情報を利用時のみ出力 フェリーの情報取得は、オプション機能のため、別途契約が必要となります |
| superexpress_train | 新幹線 | |
| sleeper_ultraexpress | 寝台特急 | 寝台料金を必要とする列車(例:サンライズ出雲) |
| ultraexpress_train | 特急 | 特急料金を必要とする列車(例:ふじさん、スカイライナー) |
| express_train | 急行 | 急行料金を必要とする列車(例:秩父路、もりよし) |
| rapid_train | 快速 | 運賃のみで乗車可能な速達列車(例:エアポート、JR東海道本線快速[アクティー]) |
| semiexpress_train | 有料列車 | 乗車整理券・ライナー券や座席整理券を必要とする列車 または全席指定の快速/普通列車など、急行以上を除く料金を必須とする列車(例:ホームライナー、TJライナー(有料区間のみ)) |
| local_train | 普通列車 | 運賃のみで乗車可能な列車 |
| unknown | 不明 |
Coordinateオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 地点の緯度 | lat | 数値 | ||
| 地点の経度 | lon | 数値 |
Fareオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 料金 | unit_{料金区分ID} | 数値 | 〇 | 料金区分IDの数だけ料金が出力される |
RouteNodeNumberオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 到着ノード | arrival | NodeNumberオブジェクト | ||
| 出発ノード | departure | NodeNumberオブジェクト |
NodeNumberオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 駅シンボル記号 | symbol | 文字列 | ||
| 駅番号 | number | 文字列 |
Transportオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 運賃情報 | fare | Fareオブジェクト | 運賃がある場合のみ出力 | |
| 行き先駅情報 | destination | NodeItemオブジェクト | langパラメータを指定した場合、指定言語の翻訳値が出力される 翻訳出来ない場合は日本語の値が出力される |
|
| 降車推奨位置 | getoff | 文字列 | 「後」や「1・2・3」のようなテキストデータで出力 数字は車両番号を示す langパラメータを指定した場合、指定言語の翻訳値が出力される 翻訳出来ない場合は日本語の値が出力される |
|
| 運行路線の推奨色 | color | 文字列 | ||
| 運行路線の名称 | name | 文字列 | langパラメータを指定した場合、指定言語の翻訳値が出力される 翻訳出来ない場合は日本語の値が出力される |
|
| 料金体系の時期 | fare_season | 文字列 | normal:通常期 busy:繁忙期 slack:閑散期 busiest: 最繁忙期 'fare'が出力されない場合は出力されない |
|
| 列車自体の名称 | self_name | 文字列 | 運行路線の名称と異なる場合に出力 langパラメータを指定した場合、指定言語の翻訳値が出力される 翻訳出来ない場合は日本語の値が出力される 路線名称を表示する場合の優先順位についてはこちらをご覧ください |
|
| 交通機関会社情報 | company | Companyオブジェクト | ||
| 路線情報 | links | Linkオブジェクト | 〇 | |
| 運行路線のID | id | 文字列 | ||
| 運行路線種別 | type | 文字列 | 「普通」や「急行」のようなテキストデータで出力 langパラメータを指定した場合、指定言語の翻訳値が出力される 翻訳出来ない場合は日本語の値が出力される |
|
| 運賃・料金連続フラグ | fare_break | FareBreakオブジェクト | ||
| 特別料金適応区間、特別料金情報 | fare_detail | FareIntervalオブジェクト | 〇 |
路線名称の表示優先順位について
路線名称を表示する際は、以下の優先順位に従って表示してください。
1. Transportオブジェクトのself_name が存在し、空文字や空白のみでない場合 → self_nameを表示
2. 上記以外 → RouteSectionItemオブジェクト (type=move) の line_name を表示
Companyオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 交通機関会社のID | id | 文字列 | ||
| 交通機関会社の名称 | name | 文字列 | langパラメータを指定した場合、指定言語の翻訳値が出力される 翻訳出来ない場合は日本語の値が出力される |
Linkオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 路線ID | id | 文字列 | ||
| 路線名 | name | 文字列 | langパラメータを指定した場合、指定言語の翻訳値が出力される 翻訳出来ない場合は日本語の値が出力される |
|
| 進行方向 | direction | 文字列 | up:上り down:下り |
|
| 行先駅情報 | destination | NodeItemオブジェクト | ||
| 区間開始駅情報 | from | NodeItemオブジェクト | ||
| 区間終端駅情報 | to | NodeItemオブジェクト | ||
| 路線の方面情報 | way | 文字列 | 1つの終着駅に走る道筋が2つ以上存在する場合に出力 (例. 山手線、大江戸線など) |
NodeItemオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 駅のID | id | 文字列 | ||
| 駅の名称 | name | 文字列 | langパラメータを指定した場合、指定言語の翻訳値が出力される 翻訳出来ない場合は日本語の値が出力される |
FareBreakオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 運賃・料金連続フラグ | unit_{料金区分ID} | 真偽値 | 〇 | false:運賃は次sectionで繰越計算する true:運賃は本sectionで計算する |
運賃の出力について
fare_break は、運賃が出力される場合に'true'となります
例:経堂~下北沢~渋谷の経路における「乗継割引」適用の場合
当該経路の場合、対象駅となる小田急線「経堂」駅から京王線「下北沢」駅での乗り継ぎで、 乗継割引 (異なる社局の特定の区間を相互に乗り継いだ際に適応される割引) が適用されます
この例における小田急線の fare_break オブジェクトは、次のように、unit_0 (普通運賃) と unit_48 (ICカード運賃) の fare_break が「false」となります
このとき、小田急線のセクションでは、運賃情報として「unit_0 (普通運賃)」と「unit_48 (ICカード運賃) 」は出力されません
運賃は、次の京王線のセクションにて乗継割引を含めた形で「unit_0 (普通運賃) 270 円」と「unit_48 (ICカード運賃)258 円」として出力されます
・fare_breakの例
"fare_break": {
"unit_130": true,
"unit_141": true,
"unit_0": false,
"unit_48": false,
"unit_133": true,
"unit_138": true,
"unit_136": true,
"unit_128": true
}
FareIntervalオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 特別料金開始ノード情報 | start | FareNodeオブジェクト | ||
| 特別料金終了ノード情報 | goal | FareNodeオブジェクト | ||
| 料金情報 | fare | 数値 | ||
| 料金区分 | id | 文字列 | unit_{料金区分ID} 形式ではなく、{料金区分ID} 形式の料金区分で出力 例:'unit_130'の場合は'130'と出力される |
|
| 特別料金デフォルト合算フラグ | default_extra_fare | 真偽値 | デフォルトで合算すべき特別料金の場合に'true'となる |
FareNodeオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 地点名称 | name | 文字列 | ||
| 駅のID | node_id | 文字列 | 駅を識別するID |
Unitオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 緯度経度の測地系 | datum | 文字列 | ||
| 緯度経度の出力形式 | coord_unit | 文字列 | ||
| 距離の単位 | distance | 文字列 | ||
| 所要時間の単位 | time | 文字列 | ||
| 通貨の単位 | currency | 文字列 |
レスポンス例
{
"outline": {
"rush_hour": {
"time": 18,
"transit_count": 0,
"transport_links": [
"JR山手線"
]
},
"daytime": {
"time": 14,
"transit_count": 0,
"transport_links": [
"JR山手線"
]
}
},
"rush_hour": {
"summary": {
"start": {
"type": "point",
"coord": {
"lat": 35.670034,
"lon": 139.702761
},
"name": "明治神宮前",
"node_id": "00008598",
"node_types": [
"station"
]
},
"goal": {
"type": "point",
"coord": {
"lat": 35.70104,
"lon": 139.700187
},
"name": "新大久保",
"node_id": "00004302",
"node_types": [
"station"
]
},
"move": {
"transit_count": 0,
"walk_distance": 416,
"fare": {
"unit_0": 170.0,
"unit_48": 167.0,
"unit_128_train": 5280.0,
"unit_130_train": 15070.0,
"unit_133_train": 25460.0
},
"type": "move",
"time": 14,
"distance": 3916,
"move_type": [
"local_train",
"walk"
]
}
},
"sections": [
{
"type": "point",
"coord": {
"lat": 35.670034,
"lon": 139.702761
},
"name": "明治神宮前",
"node_id": "00008598",
"node_types": [
"station"
],
"gateway": "2番口"
},
{
"type": "move",
"move": "walk",
"time": 5,
"distance": 416,
"line_name": "徒歩"
},
{
"type": "point",
"coord": {
"lat": 35.669957,
"lon": 139.702748
},
"name": "原宿",
"node_id": "00002128",
"node_types": [
"station"
],
"gateway": "東口",
"numbering": {
"departure": [
{
"symbol": "JY",
"number": "19"
}
]
}
},
{
"type": "move",
"transport": {
"fare": {
"unit_0": 170.0,
"unit_48": 167.0,...
},
"getoff": "前・中",
"color": "#80C241",
"name": "JR山手線",
"fare_season": "normal",
"company": {
"id": "00000004",
"name": "JR東日本"
},
"links": [
{
"id": "00000141",
"name": "JR山手線",
"direction": "down",
"destination": {
"id": "00004254",
"name": "新宿"
},
"from": {
"id": "00002128",
"name": "原宿"
},
"to": {
"id": "00004302",
"name": "新大久保"
}
}
],
"id": "00000330",
"type": "普通",
"fare_break": {
"unit_0": true,
"unit_48": true,...
},
"fare_detail": [...]
},
"move": "local_train",
"time": 7,
"distance": 3500,
"line_name": "JR山手線"
},
{
"type": "point",
"coord": {
"lat": 35.70104,
"lon": 139.700187
},
"name": "新大久保",
"node_id": "00004302",
"node_types": [
"station"
],
"numbering": {
"arrival": [
{
"symbol": "JY",
"number": "16"
}
]
}
}
]
},
"daytime": {
"summary": {
"start": {
"type": "point",
"coord": {
"lat": 35.670034,
"lon": 139.702761
},
"name": "明治神宮前",
"node_id": "00008598",
"node_types": [
"station"
]
},
"goal": {
"type": "point",
"coord": {
"lat": 35.70104,
"lon": 139.700187
},
"name": "新大久保",
"node_id": "00004302",
"node_types": [
"station"
]
},
"move": {
"transit_count": 0,
"walk_distance": 416,
"fare": {
"unit_0": 170.0,
"unit_48": 167.0,
"unit_128_train": 5280.0,
"unit_130_train": 15070.0,
"unit_133_train": 25460.0
},
"type": "move",
"time": 14,
"distance": 3916,
"move_type": [
"local_train",
"walk"
]
}
},
"sections": [
{
"type": "point",
"coord": {
"lat": 35.670034,
"lon": 139.702761
},
"name": "明治神宮前",
"node_id": "00008598",
"node_types": [
"station"
],
"gateway": "2番口"
},
{
"type": "move",
"move": "walk",
"time": 5,
"distance": 416,
"line_name": "徒歩"
},
{
"type": "point",
"coord": {
"lat": 35.669957,
"lon": 139.702748
},
"name": "原宿",
"node_id": "00002128",
"node_types": [
"station"
],
"gateway": "東口",
"numbering": {
"departure": [
{
"symbol": "JY",
"number": "19"
}
]
}
},
{
"type": "move",
"transport": {
"fare": {
"unit_0": 170.0,
"unit_48": 167.0,...
},
"getoff": "前・中",
"color": "#80C241",
"name": "JR山手線",
"fare_season": "normal",
"company": {
"id": "00000004",
"name": "JR東日本"
},
"links": [
{
"id": "00000141",
"name": "JR山手線",
"direction": "down",
"destination": {
"id": "00004254",
"name": "新宿"
},
"from": {
"id": "00002128",
"name": "原宿"
},
"to": {
"id": "00004302",
"name": "新大久保"
}
}
],
"id": "00000330",
"type": "普通",
"fare_break": {
"unit_0": true,
"unit_48": true,...
},
"fare_detail": [...]
},
"move": "local_train",
"time": 7,
"distance": 3500,
"line_name": "JR山手線"
},
{
"type": "point",
"coord": {
"lat": 35.70104,
"lon": 139.700187
},
"name": "新大久保",
"node_id": "00004302",
"node_types": [
"station"
],
"numbering": {
"arrival": [
{
"symbol": "JY",
"number": "16"
}
]
}
}
]
},
"unit": {
"datum": "wgs84",
"coord_unit": "degree",
"distance": "metre",
"time": "minute",
"currency": "JPY"
}
}
エラー情報
エラーハンドリングについて
エラーメッセージは追加/変更/削除されることがあります。
エラーハンドリングされる場合はHTTPステータスコードをもとにご対応ください。
共通エラーについてはこちらをご参照ください。
| HTTPステータス | エラーメッセージ | 発生理由 |
|---|---|---|
| 405 | This http method is invalid : POST (等) | 許可されていないHTTPメソッドでアクセスされた場合に発生します。 |
| 400 | parameter error: start: required field | 必須パラメータである start が指定されていない、または空文字の場合に発生します。 |
| 400 | parameter error: start: no definitions validate | start に指定した値のフォーマットが不正、または正しくない文字列が含まれている場合に発生します。 |
| 400 | parameter error: goal: required field | 必須パラメータである goal が指定されていない、または空文字の場合に発生します。 |
| 400 | parameter error: goal: no definitions validate | goal に指定した値のフォーマットが不正、または正しくない文字列が含まれている場合に発生します。 |
| 400 | parameter error: via: ['not json format : {value}'] | via に不正なJSON文字列を指定した場合に発生します。 |
| 400 | parameter error: via: ["'use_car' must not be present with 'via'"], use_car: ["'via' must not be present with 'use_car'"] | via と use_car を同時に指定した場合に発生します。 |
| 400 | parameter error: via_type: ['unallowed value {value}'] | via_type に specified, optimal 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: via_type: ["field 'via' is required"] | via_type を指定しているが、via が指定されていない場合に発生します。 |
| 400 | parameter error: unuse: ['an invalid item: {value}'] | unuse に許可されていない交通手段種別を指定した場合に発生します(許可値: superexpress_train, sleeper_ultraexpress, ultraexpress_train, express_train, rapid_train, semiexpress_train, local_train, ferry)。 |
| 400 | parameter error: walk_speed: ['an invalid float: {value}'] | walk_speed に数値として解釈できない文字列を指定した場合に発生します。 |
| 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: 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: {field}: ['{error}'] ※field は node, lat, lon, name, spot | start/goal をJSON形式で指定した場合の内部フィールドの値が不正な場合に発生します。 |
| 400 | parameter error: {field}: ['{error}'] ※field は lat, lon, node, stay-time, via-attribute 等 | via の各要素内のフィールドの値が不正な場合に発生します。 |
| 400 | Multiple start and goal are not allowed. | start または goal をJSON配列形式(複数地点)で指定した場合に発生します(本APIでは多地点探索は不可)。 |
| 400 | start and goal are both multiple. | start と goal の両方をJSON配列形式(複数地点)で指定した場合に発生します(transit_processing内で先にチェックされる場合)。 |
| 400 | via must be in json format | via のJSON文字列が正しい形式ではない場合に発生します。 |
| 400 | via must be in array format | via のJSONが配列ではなくオブジェクト等の場合に発生します。 |
| 400 | goal or start is multiple | via を指定しつつ、start または goal がJSON配列形式(複数地点)の場合に発生します。 |
| 400 | list size is too large | via の経由地数が契約上の上限を超過した場合に発生します。 |
| 400 | invalid point param | avoid_node に指定したノードIDが start、goal、または via と重複している場合に発生します。 |
| 400 | bad usage on this contract : Multilingual | lang パラメータを指定したが、契約で多言語オプションが有効化されていない場合に発生します。 |
| 400 | bad usage on this contract : use_company and unuse_company must be either. | 利用対象運行会社の設定に不整合がある場合に発生します。 |