自動車ルート検索

API名: 
route3/drive
概要: 
自動車の経路を返却します。経路の取得方法は以下の2種類があります。

・機能１．自動車ルート検索
リクエストパラメータで指定される出発・到着地点の緯度経度を元に該当する自動車の経路を返却します。
 
・機能２．自動車ルート候補詳細取得
  自動車ルート候補一覧取得（route3/drive_list）で出力されたルートID（routeID）を元に
  該当する自動車の経路を返却します。
 

道路規制・制限情報を考慮した探索を行う場合は、道路種別・道路条件および考慮対象情報毎にそれぞれのパラメータを指定する必要があります。
tolltype, height, width, weight, cardetailinfo これらはそれぞれ独立しており、相互には検索結果に影響を与えません。

※一部パラメータを利用するには別途契約が必要です。

URI: 

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

<API使用例 機能1. 自動車ルート検索>
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/route3/drive?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&searchType=0&from=35.792099167,139.763894444&to=35.772690278,139.753888889

<API使用例 機能2. 自動車ルート候補詳細取得>
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/route3/drive?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&routeID=THB_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

リクエストパラメータ

機能１．自動車ルート検索 リクエストパラメータ

パラメータ 必須 デフォルト値 説明
searchType ○ - 検索タイプ
ルート検索時の検索タイプを指定します。
指定値 説明
0 推奨ルート
※有料道路利用、通りやすさ、所要時間、距離などをバランスよく考慮したお奨めルート
1 一般道優先
2 道幅優先
3 距離優先
4 別ルート優先
※推奨ルートで通るルートを除いた場合の推奨ルート
searchparam   0 検索挙動変更
ルート検索の挙動を変更します。
当該パラメータを変更することにより、探索経路が変わることがあります。
指定値 説明
0 ルート所要時間計算: 旧来からの値にて計算
横付け考慮：無し
1 ※推奨
ルート所要時間計算: 普通車において最適化された値にて計算
※旧来値：0 に比べ同じ経路でのルート所要時間は平均的に短時間に計算されます。
横付け考慮：あり
※最適化の結果、横付けしない結果になる場合があります。

※ルート所要時間計算に用いる値は、料金車種,詳細車種パラメータの指定による変化はありません。
from ○ - 出発地点
検索するルートの出発地点を緯度経度で指定します。
from,toの直線距離が50m以下の場合、検索失敗となります。
to ○ - 到着地点
検索するルートの到着地点を緯度経度で指定します。
from,toの直線距離が50m以下の場合、検索失敗となります。
mpoints   - 経由地点
検索するルートの経由地点を緯度経度で指定します。
最大20点まで複数値指定できます。
fromtype   general 出発・到着地点引き込み優先タイプ
引き込みを優先する出発・到着地点の道路を指定します。
指定値 説明
general 一般道路を優先して引き込みます
highway 高速道路を優先して引き込みます
all 全ての道路に引き込みます
totype   general
mpointstype   全て
general		 経由地点引き込み優先タイプ
引き込みを優先する経由地点の道路を複数値で指定します。
本パラメータを指定した場合は、その指定数とmpointsパラメータの
経由地点数が一致する必要があります。
指定値 説明
general 一般道路を優先的に引き込みます
highway 高速道路を優先的に引き込みます
all 全ての道路に引き込みます
datum   TOKYO 測地系
入出力緯度経度の測地系を指定します。
tolltype   normal 料金車種
指定された車種で通行料金算出を行います。
本パラメータで指定された値は、ルート検索時の車種別規制考慮と、車のサイズを考慮したルート検索には影響しません。
ルート検索時の車種別規制考慮をする場合は、詳細車種(cardetailinfo)を指定ください。
車のサイズを考慮したルート検索は、車高(height)、車幅(width)、車重(weight)を指定ください。
指定値 説明
light 軽自動車
normal 普通車
middle 中型車
large 大型車
big 特大車
smartic   F スマートIC利用指定
検索時にスマートICを利用するかどうかを真偽値で指定します。
llunit   dec 緯度経度形式
入出力緯度経度形式を指定します。
departuretime   - 出発時刻指定
出発時刻を日時で指定します。
規制考慮(regulation)指定時、指定時刻を考慮します。これらのパラメータ未設定時は出力に影響を与えません。
cardetailinfo   D 詳細車種
指定された車種の規制情報を考慮してルート検索を行います。
本パラメータで指定された値は、通行料金算出と、車のサイズを考慮したルート検索には影響しません。
通行料金算出に車種指定をする場合は、料金車種(tolltype)を指定ください。
車のサイズを考慮したルート検索は、車高(height)、車幅(width)、車重(weight)を指定ください。
※本機能を利用する場合には別途契約が必要です。
指定値 説明
0 中型乗用自動車
1 マイクロバス
2 特定中型乗用自動車
3 大型乗用自動車
4 普通貨物自動車1t
5 準中型貨物自動車2t
6 準中型貨物自動車2.5t
7 準中型貨物自動車3t
8 準中型貨物自動車3.5t
9 準中型貨物自動車4t
A 特定中型貨物自動車
B 大型貨物自動車
C 大型特殊自動車
D 普通乗用自動車
E 準中型乗用自動車
F 中型貨物自動車
twouturn   F 2段階Uターン回避
2段階Uターン回避を利用するかどうかを真偽値で指定します。
詳細車種(cardetailinfo)で指定された車種での2段階Uターンを行うルートを回避します。
2段階Uターンとは、近距離で2度の右折または左折をする地点の事を表しています。
※本機能を利用する場合には別途契約が必要です。
ferry   T フェリー考慮
フェリーを利用するかどうかを真偽値で指定します。
なお、F指定にした場合でもフェリーを利用しないと到達不可能な場合、
フェリー航路を含む結果が返却されます。
指定値 説明
T フェリーを利用する
F フェリーを利用しない
tollTBD   F 通行料金未提供区間制御フラグ
料金情報が提供されていない道路を回避するかどうかを真偽値で指定します。
T指定した場合、料金情報が提供されていない道路を回避します。
※目的地までの通行可能なルートがない場合、通行料金未提供の道路を含むルートを返却します。
avoidarea   - 矩形エリア回避
ルート検索時に迂回するエリアを緯度経度矩形範囲で指定します。
10件まで複数指定可能です。
10kmを超える矩形が指定された場合、エラーとなります。
国外の緯度経度を含む矩形が指定された場合、回避対象から除外してルート検索を行います。
※該当エリアを通過しないとルートが作成できない場合、該当エリアを迂回せず通過するルートが作成されます。
※緯度経度形式で指定した値と異なる形式の緯度経度を指定した場合、動作保証対象外です。
heading   - 進行方向
進行方向の角度を指定します。
角度は真北を0度とし、0～359までの整数で指定します。
未指定の場合、進行方向は無視されます。
また、範囲外の値を指定した場合、エラーとなります。

機能２．自動車ルート候補詳細取得 リクエストパラメータ

パラメータ 必須 デフォルト値 説明
routeID ○ - ルートID
自動車ルート候補一覧取得から返却されたIDを指定します。
本パラメータが指定されている場合は指定したルートIDの詳細情報を取得するモードとなります。
この時、datum、liunit、height、width、weight、regulation以外のパラメータの指定は無視されます。
height、width、weight、regulationは、規制情報による通行可否の判定でのみ利用されます。
なお、取得後24時間を超えたルートIDは利用できません。
自動車ルート候補詳細取得時は、ルート探索をした結果を再取得するものであり、再探索はしません。
時間経過後に取得しても、規制情報の更新を反映する事はありません。
searchparam   0 検索挙動変更
ルート検索の挙動を変更します。
当該パラメータを変更することにより、取得料金が変わることがあります。
※自動車ルート候補一覧取得での指定値と一致させてください。
　searchparam=1とsearchparam=0を変えた場合はエラーまたは誤った値が返却される場合があります。
指定値 説明
0 ルート所要時間に旧来からの値を使用します。
1 ルート所要時間に最適化した値を使用します。
（デフォルト値 ：0) に比べ平均的にルート所要時間が短縮されます。※推奨
datum   TOKYO 測地系
出力緯度経度の測地系を指定します。
llunit   dec 緯度経度形式
出力緯度経度形式を指定します。

規制考慮・車両制限パラメータ 機能1・2共通
パラメータ 必須 デフォルト値 説明
height   - 車高
車高を0～65534の整数で指定します。(単位:cm)
本パラメータを指定すると道路情報を考慮し、車高による車両制限を加味したルート検索を行います。
無指定時は車高による車両制限は加味されません。
routeID パラメータ指定時は、規制情報による通行可否の判定でのみ利用されます。
※目的地までの通行可能な経路がない場合、通行不可な道路を含む経路を返します。
width   - 車幅
車幅を0～65534の整数で指定します。(単位:cm)
本パラメータを指定すると道路情報を考慮し、車幅による車両制限を加味したルート検索を行います。
無指定時は車幅による車両制限は加味されません。
routeID パラメータ指定時は、規制情報による通行可否の判定でのみ利用されます。
※目的地までの通行可能な経路がない場合、通行不可な道路を含む経路を返します。
weight   - 車重
車両総重量を0～65534の整数で指定します。(単位:kg)
本パラメータを指定すると道路情報を考慮し、車重による車両制限を加味したルート検索を行います。
無指定時は車重による車両制限は加味されません。
routeID パラメータ指定時は、規制情報による通行可否の判定でのみ利用されます。
※目的地までの通行可能な経路がない場合、通行不可な道路を含む経路を返します。
regulation   - 規制考慮
詳細車種(cardetailinfo)で指定された車種と指定された規制情報を考慮してルート検索を行います。
下記のパラメータを指定します。複数値指定できます。
routeID パラメータ指定時は、規制情報による通行可否の判定でのみ利用されます。
※目的地までの通行可能なルートがない場合、通行不可な道路を含むルートを返します。
指定日時～指定日時＋65分の間の時間帯規制・季節規制を対象として考慮します。
考慮範囲は 出発地点より直線距離で10km以内です。到着地点が、出発地点より10kmを超える位置にあった場合は、到着地点の規制情報は考慮されません。
※本機能を利用する場合には別途契約が必要です。
指定値 説明
season 季節規制考慮
departuretimeパラメータで指定した日時で季節規制を考慮します。
departuretimeの指定が無い場合は現在時での動作となります。
time 時間帯規制考慮
departuretimeパラメータで指定した日時で時間帯規制を考慮します。
departuretimeの指定が無い場合は現在時での動作となります。

出力データ
出力フォーマット
{"status":{"code":"string",
           "text":"string"},
 "route":{"routeID":string,
          "toll":number,
          "invalidFee:boolean",
          "distance":number,
          "time":number,
          "link":[{"roadType":"string",
                   "tollFlag":boolean,
                   "toll":number,
                   "line":{"latlon":[]},
                   "distance":number,
                   "guidance":{"guidancecode":string,
                               "routeName":string,
                               "pointName":string,
                               "directionName":string,
                               "pointflg":{"ic":boolean,
                                           "jct":boolean,
                                           "sa":boolean,
                                           "pa":boolean},
                               "imageurl":[],
                   "linkID":string,
                   "facilityName":[{"name":string,
                                    "type":string}],
                   "facilityInfo":[{"name":string,
                                    "type":{"ic":boolean,
                                            "jct":boolean,
                                            "tollgate":boolean,
                                            "sapa":boolean,
                                            "smartic":boolean}}],
                   "regulation":{"height":number,
                                 "width":number,
                                 "weight":number},
                   "passagelink":boolean},...],
          "detailedTime":[{"time":number,
                          "linkOffset":number,
                          "linkLength":number},...],
          "passage":boolean,
          "vicsTimeStamp":string,
          "tollStatus":string}
}
キー名 データ型 説明
status         object ステータス情報が入ります。
  code       string ステータスコードが入ります。
コード一覧については別表をご覧ください。
  text       string 常に空が入ります。
route         object ルート検索結果が入ります。
  routeID       string ルートIDが入ります。
  toll       number 合計の通常料金(現金の料金)(単位:円)が入ります。
  invalidFee       boolean 算出された合計料金が無効値であったかどうかを示すフラグが入ります。
料金無効値は、経路結果に新規開通などで料金が反映されていない区間が含まれている場合に発生します。
true 料金無効値があった
false 料金無効値がなかった
  distance       number 合計距離(単位:m)が入ります。
  time       number 合計時間(単位:分)が入ります。
走行時間が不明な場合はnullが入ります。
  link       array リンク情報の配列が入ります。
    roadType     string 当該リンクの道路種別が入ります。
    tollFlag     boolean 当該リンクが有料道路かどうかを示すフラグが真偽値で入ります。
    toll     number 料金が入ります。
    distance     number 当該リンクの距離(単位:m)が入ります。
    line     object 当該リンクの形状データが入ります。
      latlon   array 形状ポリラインデータが入ります。
    guidance     object 当該リンクの地点型誘導情報が入ります。
誘導情報が存在しない場合はnullが入ります。
      guidancecode   string 右左折情報が入ります。
右左折情報が存在しない場合はnullが入ります。
0 直進方向
1 斜め右方向
2 斜め左方向
3 右方向
4 左方向
5 右斜め後方
6 左斜め後方
7 Uターン
      pointName   string 交差点名称が入ります。
交差点名称の情報が存在しない場合はnullが入ります。
      routeName   string 道路名称が入ります。
道路名称の情報が存在しない場合はnullが入ります。
      directionName   string 方面名称が入ります。
方面名称の情報が存在しない場合はnullが入ります。
      pointflg   object 高速道路上の施設への接続の可否が入ります。
        ic boolean ICに接続可能かどうかを示すフラグが入ります。
        jct boolean jctに接続可能かどうかを示すフラグが入ります。
        sa boolean saに接続可能かどうかを示すフラグが入ります。
        pa boolean paに接続可能かどうかを示すフラグが入ります。
      imageurl   array 誘導画像情報が入ります。
画像が存在しない場合空配列となります。
        url string 画像取得URLが返却されます。
        type string 画像タイプが返却されます。
1 行き先看板
4 高速分岐図
5 3D交差点拡大図
7 交差点イメージ図(都市高速入り口画像(完結画像))
8 交差点イメージ図(都市高速入り口画像(継続画像))
9 SA・PA看板画像
10 料金所後方面看板
11 ETC
    linkID     string ZリンクIDが入ります。
    facilityName     object 高速道路上の施設情報が返却されます。
施設情報が存在しない場合空配列となります。
※非推奨パラメータです。facilityInfoの使用をお奨めします。
      type   string 施設タイプが返却されます。
      name   string 施設名称が返却されます。
    facilityInfo     array 高速道路上の施設情報のオブジェクトが配列で返却されます。
      name   string 施設名称が返却されます。
      type   object 施設タイプが真偽値で返却されます。
ic ICの施設であるかどうか
jct JCTの施設であるかどうか
tollgate 料金所の施設であるかどうか
sapa SA/PAの施設であるかどうか
smartic スマートICの施設であるかどうか
    regulation     object 道路規制情報が返却されます。
      height   number 道路の高さ規制情報が入ります。(単位:cm)
高さ規制の情報が存在しない場合はnullが入ります。
      width   number 道路の幅の規制情報が入ります。(単位:cm)
幅の規制情報が存在しない場合はnullが入ります。
      weight   number 道路の重量規制情報が入ります。(単位:kg)
重量規制の情報が存在しない場合はnullが入ります。
    passagelink     boolean 当該リンクが高さ、幅、重量の規制及び季節規制、時間帯規制を回避できているかを示すフラグが入ります。
リクエストパラメータに規制考慮・車両制限パラメータを指定した状態で規制を回避できない場合、規制にかかるルートを返却する場合があります。
routeID指定時の検索では、route3/driveまたはroute3/drive_listで指定した規制考慮・車両制限パラメータと同じ値を指定しない限り正しい値とはなりません。
true 規制がない、または規制にかからない
false 規制にかかる
 
  detailedTime       array 検索されたルートにおける、区間ごとの所要時間情報のオブジェクトが配列で入ります。
    time     number 当該区間の所要時間が入ります。(単位:分)
    linkOffset     number 当該区間が対応する出力パラメータlinkの開始リンク位置(インデックス値)が入ります。
    linkLength     number 当該区間が対応する出力パラメータlinkの数が入ります。
  passage       boolean 検索されたルートが高さ、幅、重量の規制及び季節規制、時間帯規制を回避できているかどうかを示すフラグが入ります。
リクエストパラメータに規制考慮・車両制限パラメータを指定した状態で規制を回避できない場合、規制にかかるルートを返却する場合があります。
routeID指定時の検索では、route3/driveまたはroute3/drive_listで指定した規制考慮・車両制限パラメータと同じ値を指定しない限り正しい値とはなりません。
true 回避できている
false 回避できていない
  vicsTimeStamp       string nullが入ります。
  tollStatus       string 算出された合計料金に無効値が存在するかどうかが入ります。
無効値がある場合、その要因を表します。
00000 料金無効値なし
10000 料金未提供区間を通過する
01000 計算失敗した料金所が存在する
00100 開始地点が有料道路上である
00010 終了地点が有料道路上である
00001 フェリーを通過する

複数の要因が含まれる場合は以下のような返却になります。

00110 開始地点が有料道路上、終了地点が有料道路上である
10011 料金未提供区間を通過、終了地点が有料道路上、フェリーを通過する

ステータスコード
0000 正常終了
※出発地点・経由地点・到着地点のいずれかに国外の緯度経度を指定してルート検索に失敗した場合にも同じ値が入ります。
1004 検索結果のデータサイズが規定値を超えた場合
以下対応を行うことにより、解消される可能性があります。
・出発地/到着地間の距離を短くする
・経由地点を減らす
1020 データに基づく異常が発生した場合
本エラーコードが返却された場合、技術サポート窓口よりサポートまでお問い合わせください。
1400/1403 一時的に接続状態に異常が見られた場合
以下対応を行うことにより、解消される可能性があります。
・出発地/到着地間の距離を短くする
・経由地点を減らす
・数分程度時間をおいて再度リクエストする
1404 出発地点の検索に失敗した場合
1405 経由地点・到着地点の検索に失敗した場合
1406/1407 出発地点・経由地点・到着地点間をつなぐルートの作成に失敗した場合
1501 出発地点・到着地点間の距離が近すぎる場合（※50m以内）
1900 エンジンが作成した経路探索結果が1MB以上の場合
出力例

[通常出力例 機能1. 自動車ルート検索]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/route3/drive?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip
&searchType=0&from=35.672830768,139.753336154&to=35.650643034,139.697293843

{"status":{"code":"0000",
           "text":""},
 "route":{"routeID":THB_2aca576583926150c73bf5f999ad1ec7,
          "toll":1300,
          "invalidFee":false,
          "distance":5889,
          "time":7,
          "link":[{"roadType":"都市高速道路",
                   "tollFlag":true,
                   "toll":0,
                   "line":{"latlon":[35.6690722,139.7493894,...]},
                   "distance":87,
                   "guidance":{"guidancecode":null,
                               "routeName":null,
                               "pointName":null,
                               "directionName":null,
                               "pointflg":{"jc":true,
                                           "jct":false,
                                           "sa":false,
                                           "ps":false},
                               "imageurl":[]},
                   "linkID":"330831",
                   "facilityName":[{"name":"霞が関",
                                    "type":"IC"}],
                   "facilityInfo":[{"name":"霞が関"
                                    "type":{"ic":true,
                                            "jct":false,
                                            "tollgate":false,
                                            "sapa":false,
                                            "smartic":false}}],
                   "regulation":{"height":null,
                                 "width":null,
                                 "weight":null},
                   "passagelink":true},
          "detailedTime":[{"time": 0.01615384593606,
                           "linkOffset": 0,
                           "linkLength": 1},
                          {"time": 0.11547619104385,
                           "linkOffset": 1,
                           "linkLength": 1}, ...],
          "passage":true,
          "vicsTimeStamp":null,
          "tollStatus": "00000"}

[通常出力例 機能2. 自動車ルート候補詳細取得]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/route3/drive?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&routeID=THB_2aca576583926150c73bf5f999ad1ec7

{"status":{"code":"0000",
           "text":""},
 "route":{"routeID":THB_3aca687694037261c73bf5f999ad1ec8,
          "toll":0,
          "invalidFee":false,
	  "distance":257,
          "time":16,
	  "link":[{"roadType":"一般道路(その他)",
	           "tollFlag":false,
	           "toll":0,
	           "line":{"latlon":[35.6251592,139.7437803,35.6250981,139.7435536]},
	           "distance":22,
	           "guidance":{"guidancecode":4,
	                       "routeName":null,
	                       "pointName":null,
	                       "directionName":null,
	                       "pointflg":{"ic":false,
	                                   "jct":false,
	                                   "sa":false,
	                                   "pa":false},
	                       "imageurl":[]},
	           "linkID":2182772,
	           "facilityName":[],
                   "facilityInfo":[],
	           "regulation":{"height":null,
	                         "width":null,
	                         "weight":null},
                   "passagelink":true},
	          {"roadType":"一般道路(その他)",
	           "tollFlag":false,
	           "toll":0,
	           "line":{"latlon":[35.6250981,139.7435536,35.625,139.7435225]},
	           "distance":11,
	           "guidance":null,
	           "linkID":2185439,
	           "facilityName":[],
                   "facilityInfo":[],
	           "regulation":{"height":null,
	                         "width":null,
	                         "weight":null},
                   "passagelink":true},
                  {"roadType":"一般道路(その他)",
	           "tollFlag":false,
                   "toll":0,
	           "line":{"latlon":[35.625,139.7435225,35.6244811,139.7433622]},
	           "distance":59,
	           "guidance":null,
	           "linkID":2185438,
	           "facilityName":[],
                   "facilityInfo":[],
	           "regulation":{"height":null,
	                         "width":null,
	                         "weight":null},
                   "passagelink":true},
	          {"roadType":"一般道路(その他)",
	           "tollFlag":false,
	           "toll":0,
	           "line":{"latlon":[35.6244811,139.7433622,35.6239622,139.7431944]},
	           "distance":60,
	           "guidance":null,
	           "linkID":2185438,
	           "facilityName":[],
                   "facilityInfo":[],
	           "regulation":{"height":null,
	                         "width":null,
	                         "weight":null},
                   "passagelink":true},
	          {"roadType":"一般道路(その他)",
	           "tollFlag":false,
	           "toll":0,
	           "line":{"latlon":[35.6239622,139.7431944,35.6234433,139.7430267]},
	           "distance":60,
	           "guidance":null,
	           "linkID":2185438,
	           "facilityName":[],
                   "facilityInfo":[],
	           "regulation":{"height":null,
	                         "width":null,
	                         "weight":null},
                   "passagelink":true},
	          {"roadType":"一般道路(その他)",
	           "tollFlag":false,
	           "toll":0,
	           "line":{"latlon":[35.6234433,139.7430267,35.6230483,139.7428986]},
	           "distance":45,
                   "guidance":null,
                   "linkID":2185438,
                   "facilityName":[],
                   "facilityInfo":[],
                   "regulation":{"height":null,
                                 "width":null,
                                 "weight":null},
                   "passagelink":true}, ...],
          "detailedTime":[{"time": 0.01615384593606,
                           "linkOffset": 0,
                           "linkLength": 1},
                          {"time": 0.11547619104385,
                           "linkOffset": 1,
                           "linkLength": 1}, ...],
          "passage":true,
          "vicsTimeStamp":null,
          "tollStatus": "00000"}
}

[ルート検索に失敗した例]
ルート検索に失敗した場合には、返却値routeがnullとなります。
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/route3/drive?
if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&searchType=0&
from=35.473918913,139.152131508&to=35.480325169,139.216727924

{"status":{"code":"1404",
          "text":""},
 "route":null}

よくあるご質問