自動車経路検索

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

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

※一部パラメータを利用するには別途契約が必要です。
※一部開発中の機能があります。

URI: 

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

<API使用例 機能1. 自動車経路検索>
http://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

リクエストパラメータ

機能1.自動車経路検索 リクエストパラメータ

パラメータ 必須 デフォルト値 説明
searchType   検索タイプ
ルート検索時の検索タイプを指定します
指定値 説明
0 推奨ルート
1 一般道優先
2 道幅優先
3 距離優先
4 別ルート優先
from - 出発地点
検索するルートの出発地点を緯度経度で指定します。
to - 到着地点
検索するルートの到着地点を緯度経度で指定します。
datum   TOKYO 測地系
入出力緯度経度の測地系を指定します。
mpoints   - 経由地点
検索するルートの経由地点を緯度経度で指定します。
最大20点まで複数値指定できます。
tolltype   normal 料金車種
通行料金算出時に使用される車種を指定します。
指定値 説明
light 軽自動車
normal 普通車
middle 中型車
large 大型車
big 特大車
height   - 車高
車高を0~65534の整数で指定します。単位は(cm)です。
本パラメータを指定すると道路情報を考慮し、車高による車両制限を加味したルート検索を行います。無指定時は車高による車両制限は加味されません。
※目的地までの通行可能な経路がない場合、通行不可な道路を含む経路を返します。
width   - 車幅
車幅を0~65534の整数で指定します。単位は(cm)です。
本パラメータを指定すると道路情報を考慮し、車幅による車両制限を加味したルート検索を行います。無指定時は車幅による車両制限は加味されません。
※目的地までの通行可能な経路がない場合、通行不可な道路を含む経路を返します。
weight   - 車重
車重を0~65534の整数で指定します。単位は(kg)です。
本パラメータを指定すると道路情報を考慮し、車重による車両制限を加味したルート検索を行います。無指定時は車重による車両制限は加味されません。
※目的地までの通行可能な経路がない場合、通行不可な道路を含む経路を返します。
smartic   F スマートIC利用指定
検索時にスマートICを利用するかどうかを真偽値で指定します。
llunit   dec 緯度経度形式
入出力緯度経度形式を指定します。
vics   F VICS指定
VICSを加味した経路検索を行うかどうかを真偽値で指定します。
statistics パラメータをT指定または departuretimeパラメータを指定している場合に本パラメータをT指定するとパラメータエラーとなります。
※本機能を利用する場合には別途契約が必要です。
departuretime   - 出発時刻指定
出発時刻を日時で指定します。
vicsパラメータをTに指定して、本パラメータを指定した場合にはパラメータエラーとなります。
statistics   F 渋滞統計情報
渋滞統計情報を考慮した経路探索を行うかどうかを真偽値で指定します。
本パラメータを有効(T)にするとdeparturetimeパラメータが必須パラメータになり、この指定時刻を元に渋滞統計情報を利用して経路探索を行います。
なお、渋滞統計情報のデータが存在するのは15分後~1年後の間となります。この範囲外の時刻を departuretime パラメータで指定した場合、経路探索結果に渋滞統計情報は考慮されません。
vicsパラメータをT指定して本パラメータをT指定するとパラメータエラーとなります。
※本機能を利用する場合には別途契約が必要です。
cardetailinfo   D 詳細車種
規制考慮(regulation)、二段階Uターン回避(twouturn)に使用する車種を指定します。
※本機能を利用する場合には別途契約が必要です。
※本機能は開発中の機能です。
指定値 説明
0 中型乗用自動車
1 マイクロバス
2 特定中型乗用自動車
3 大型乗用自動車
4 普通貨物自動車1t
5 普通貨物自動車2t
6 普通貨物自動車2.5t
7 中型貨物自動車3t
8 中型貨物自動車3.5t
9 中型貨物自動車4t
A 特定中型貨物自動車
B 大型貨物自動車
C 大型特殊自動車
D 普通乗用自動車
regulation   - 規制考慮
cardetailinfoで指定された車種と指定された規制情報を考慮して経路検索を行います。
下記のパラメータを指定します。複数値指定できます。

※目的地までの通行可能な経路がない場合、通行不可な道路を含む経路を返します。
※本機能を利用する場合には別途契約が必要です。
※本機能は開発中の機能です。

指定値 説明
season 季節規制考慮
departuretimeパラメータで指定した日時で季節規制を考慮します。
vicsがT指定されている場合、またはdeparturetimeの指定が無い場合は現在時での動作となります。
time 時間帯規制考慮
departuretimeパラメータで指定した日時で時間帯規制を考慮します。
vicsがT指定されている場合、またはdeparturetimeの指定が無い場合は現在時での動作となります。
twouturn   F 2段階Uターン回避
cardetailinfoで指定された車種で2段階Uターンを行うルートを回避します。
※本機能を利用する場合には別途契約が必要です。
※本機能は開発中の機能です。

機能2.自動車経路候補詳細取得 リクエストパラメータ

パラメータ 必須 デフォルト値 説明
routeID   ルートID
自動車経路候補一覧取得(route3/drive_list)から返却されたIDを指定します。
本パラメータが指定されている場合は市営下ルートIDの詳細情報を取得するモードとなります。
この時、datum及びliuni以外のパラメータの指定は無視されます。
なお、取得後24時間を超えたルートIDは利用できません。
datum   TOKYO 測地系
出力緯度経度の測地系を指定します。
llunit   dec 緯度経度形式
出力緯度経度形式を指定します。

出力データ
出力フォーマット
{"status":{"code":"0000",
           "text":""},
 "route":{"toll":0,
          "distance":5888,
          "time":16,
          "link":[{"roadType":"都道府県道",
                   "tollFlag":false,
                   "toll":0,
                   "line":{"latlon":[35.7306672,139.7512833,35.7303617,139.7515106]},
                   "distance":40,
                   "guidance":null,
                   "linkID":799041,
                   "facilityName":[],
                   "facilityInfo":[],
                   "regulation":{"height":null,
                                 "width":null,
                                 "weight":null}},
          ...}
キー名 データ型 説明
status         object ステータス情報が入ります。
  code       string ステータスコードが入ります。  
0000 正常終了
0001 タイムアウトが発生またはデータサイズが
制限値を超えたため処理が中断された
  text       string ステータス内容に関するテキスト情報が入ります。
route         object ルート検索結果が入ります。
  distance       number 合計距離(メートル)が入ります。
  toll       number 合計料金(円)が入ります。
  time       number 合計時間(分)が入ります。走行時間が不明な場合はNULLが入ります。
  link       array リンク情報の配列が入ります。
    roadType     string 当該リンクの道路種別が入ります。
    tollFlag     boolean 当該リンクが有料道路かどうかを示すフラグが真偽値で入ります。
    toll     numver 料金が入ります。
    distance     number 当該リンクの距離(メートル)が入ります。
    line     object 当該リンクの形状データが入ります。
      latlon   array 形状ポリラインデータが入ります。
    guidance     object 当該リンクの地点型誘導情報が入ります。誘導情報が存在しない場合はnullが入ります。
      guidancecode   string 右左折情報が入ります。
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 リンクIDが入ります。
    facilityName     object 高速道路上の施設情報が返却されます。
施設情報が存在しない場合空配列となります。
※非推奨パラメータです。facilityInfoの使用をお奨めします。
      type   string 施設タイプが返却されます。
      name   string 施設名称が返却されます。
    facilityInfo       高速道路上の施設情報のオブジェクトが配列で返却されます。
      type     施設タイプが真偽値で返却されます。
ic ICの施設であるかどうか
jct JCTの施設であるかどうか
tollgate 料金所の施設であるかどうか
sapa SA/PAの施設であるかどうか
smartic スマートICの施設であるかどうか
      name     施設名称が返却されます。
    regulation     object 道路規制情報が返却されます。
      height   number 道路の高さ規制情報が入ります。単位(cm)
高さ規制の情報が存在しない場合はnullが入ります。
      width   number 道路の幅の規制情報が入ります。単位(cm)
幅の規制情報が存在しない場合はnullが入ります。
      weight   number 道路の重量規制情報が入ります。単位(kg)
重量規制の情報が存在しない場合はnullが入ります。
出力例

[通常出力例 機能1. 自動車経路検索] http://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

{"status":{"code":"0000",
           "text":""},
 "route":{"toll":0,
          "distance":2966,
          "time":16,
          "link":[{"roadType":"一般道路(その他)",
                   "tollFlag":false,
                   "toll":0,
                   "line":{"latlon":[35.7920692,139.7638769,35.7921092,139.7638092]},
                   "distance":8,
                   "guidance":null,
                   "linkID":"8270748",
                   "facilityName":[],
                   "facilityInfo":[],
                   "regulation":{"height":null,
                                 "width":null,
                                 "weight":null}},
                  {"roadType":"都道府県道",
                   "tollFlag":false,
                   "toll":0,
                   "line":{"latlon":[35.7921092,139.7638092,35.7919919,139.7636947]},
                   "distance":17,
                   "guidance":null,
                   "linkID":"800840",
                   "facilityName":[],
                   "facilityInfo":[],
                   "regulation":{"height":null,
                                 "width":null,
                                 "weight":null}},
                  {"roadType":"都道府県道",
                   "tollFlag":false,
                   "toll":0, 
                   "line":{"latlon":[35.7919919,139.7636947,35.7916919,139.7634353]},
                   "distance":41,
                   "guidance":null,
                   "linkID":"800841",
                   "facilityName":[],
                   "facilityInfo":[],
                   "regulation":{"height":null,
                                 "width":null,
                                 "weight":null}},
                  {"roadType":"都道府県道",
                   ・
                   ・
                   ・
                  }]}}

[通常出力例 機能2. 自動車経路候補詳細取得] http://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":{"toll":0,
	  "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}},
	          {"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}},
                  {"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}},
	          {"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}},
	          {"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}},
	          {"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}}]}}