ETC料金取得

API名: 
route3/etc_toll
概要: 

自動車ルート検索(route3/drive)、または自動車ルート候補一覧取得(route3/drive_list)で
検索した区間のETC料金情報を取得します。
※本機能を利用する場合には別途契約が必要です。

pvについて:
ICの乗降が発生する毎に1pvです。
高速道路から高速道路へ乗り継ぐ場合のpv加算はありません。
詳細はこちらをご確認ください。

情報元について:
ETC料金情報元：住友電気工業株式会社
このAPIが返却する上記情報は、情報元の提供基準に準拠します。
未対応の有料道路、キャンペーン料金は結果に反映されません。

URI: 

https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/route3/etc_toll

<API使用例>
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/route3/etc_toll?if_clientid=JSZxxxxxxxxxx|xxxxx&routeID=THB_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

リクエストパラメータ
パラメータ 必須 デフォルト値 説明
routeID ○ - ルートID
route3/drive、またはroute3/drive_listで取得したルートIDを指定します。
なお、取得後24時間を超えたルートIDは利用できません。
本項目は必須項目であるため、未指定の場合はエラーとなります。
※使用できるルートIDは「searchparam=1」で取得したもののみとなります。
tolltype     車種区分
通行料金算出に使用する車種を指定します。
※未指定の場合route3/drive、route3/drive_list実行時に指定した車種を元に算出します。
指定値 説明
light 軽自動車
normal 普通車
middle 中型車
large 大型車
big 特大車
departuretime   ※ 日時
出発時刻を日時で指定します。指定可能範囲は現在時刻から前後1年間です。
未指定の場合、現在時刻になります。

出力データ
出力フォーマット
{"status":{"code": "0000",
           "text": ""},
 "item":{"toll": 1190,
         "enterHighway": 1,
         "invalidFee": false,
         "link":[{"toll": 600,
                  "invalidFeeLink": false,
                  "ic": {"from": "霞が関",
                         "to": "用賀"}},
                 {"toll": 590,
                  "invalidFeeLink": false,
                  "ic": {"from": "東京",
                         "to": "横浜青葉"}}]}}
キー名 データ型 説明
status       object ステータス情報が入ります。
  code     string ステータスコードが入ります。
0000 正常終了
1101 取得したルート形状の点列の数が、全ルート含めて1件もない
1102 ルート探索の出発地点・最終目的地点に有料道路を指定した
1103 出力するルート形状の点列数が制限値を超えた
1201 routeIDの入力間違い・有効期限切れ等、存在しないIDが指定された
  text     string 空文字列が入ります。
item       object 1ルート分のETC料金の取得結果が入ります。
  toll     number 1ルート分のETC料金の合計が入ります。
invalidFeeが一つでもtrueの場合、結果は0になります。
  enterHighway     number 高速道路の進入回数が入ります。
1 ルート結果内で1度だけ高速道路に進入した
2以上 ルート結果内で高速道路から退出した後、
再度高速道路に進入した
  invalidFee     boolean 料金不明区間があったかどうかが入ります。
true 料金不明区間であった
false 料金不明区間ではなかった
  link     array 区間ごとの結果オブジェクトが配列で入ります。
    toll   number 1区間分のETC料金が入ります。
    invalidFee   boolean 料金不明区間であったかどうかが入ります。
true 料金不明区間であった
false 料金不明区間ではなかった
    ic   object IC名が入ります。
      from string 進入IC名が入ります。
      to string 退出IC名が入ります。

出力例

[通常出力例：高速の乗り降りを1回含むルートの時]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/route3/etc_toll?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&routeID=THB_xxx

{"status":{"code": "0000",
           "text": ""},
 "item":{"toll": 1190,
         "enterHighway": 1,
         "invalidFee": false,
         "link":[{"toll": 600,
                  "invalidFee": false,
                  "ic": {"from": "霞が関",
                         "to": "用賀"}}]}}
[通常出力例：複数のICを経由するが、高速道路からは降りない時]
○○高速から○○道に乗り継ぐルート場合等

https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/route3/etc_toll?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&routeID=THB_xxx

{"status":{"code": "0000",
           "text": ""},
 "item":{"toll": 1190,
         "enterHighway": 1,
         "invalidFee": false,
         "link":[{"toll": 600,
                  "invalidFee": false,
                  "ic": {"from": "霞が関",
                         "to": "用賀"}},
                 {"toll": 590,
                  "invalidFee": false,
                  "ic": {"from": "東京",
                         "to": "横浜青葉"}}]}}
[通常出力例：高速道路を降り、再度高速に乗る時]
経由地点に一般道を指定し、高速道路を通るルートの場合等

https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/route3/etc_toll?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&routeID=THB_xxx

{"status":{"code": "0000",
           "text": ""},
   "item":{"toll": 3180,
           "enterHighway":2,
           "invalidFee": false,
           "link":[{"toll": 490,
                    "invalidFee": false,
                    "ic": {"from": "大井南",
                           "to": "浮島"}},
                   {"toll": 800,
                    "invalidFee": false,
                    "ic": {"from": "木更津金田",
                           "to": "木更津金田"}},
                   {"toll": 160,
                    "invalidFee": false,
                    "ic": {"from": "木更津金田",
                           "to": "袖ヶ浦"}},
                   {"toll": 160,
                    "invalidFee": false,
                    "ic": {"from": "袖ヶ浦",
                           "to": "木更津金田"}},
                   {"toll": 800,
                    "invalidFee": false,
                    "ic": {"from": "木更津金田",
                           "to": "木更津金田"}},
                   {"toll": 770,
                    "invalidFee": false,
                    "ic": {"from": "浮島",
                           "to": "東神奈川"}}]}}
[通常出力例：料金不明区間が存在した時]
経由地点に一般道を指定し、高速道路を通るルートの場合等

https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/route3/etc_toll?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&routeID=THB_xxx

{"status":{"code": "1001",
           "text": ""},
   "item":{"toll": 0,
           "enterHighway":2,
           "invalidFee": true,
           "link":[{"toll": 490,
                    "invalidFee": false,
                    "ic": {"from": "大井南",
                           "to": "浮島"}},
                   {"toll": 0,
                    "invalidFee": true,
                    "ic": {}},
                   {"toll": 160,
                    "invalidFee": false,
                    "ic": {"from": "木更津金田",
                           "to": "袖ヶ浦"}}]}}

[検索失敗時]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/route3/etc_toll?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip

{"status": {"code": "1002",
            "text": "ルート探索の出発地点・最終目的地点に有料道路を指定した"},
   "item": {null}}