自動車ルート候補一覧取得

API名:

route3/drive_list

概要:

緯度経度から自動車のルート候補を取得します。
取得した各ルートは、そのルートIDを自動車ルート検索にて指定することで更に詳細情報を取得できます。
道路規制・制限情報を考慮した探索を行う場合は、道路種別・道路条件および考慮対象情報毎にそれぞれのパラメータを指定する必要があります。
tolltype, height, width, weight, cardetailinfo これらはそれぞれ独立しており、相互には検索結果に影響を与えません。

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

URI:

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

<API使用例>
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/route3/drive_list?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&from=35.792099167,139.763894444&to=35.772690278,139.753888889

リクエストパラメータ

パラメータ

必須

デフォルト値

説明

searchparam

検索挙動変更
ルート検索の挙動を変更します。
※自動車ルート検索を使用する場合は、指定値を一致させてください。
searchparam=1とsearchparam=0を違えた場合はエラーまたは誤った値が返却される場合があります。

指定値	説明
0	ルート所要時間計算：旧来からの値にて計算横付け考慮：無し
1	※推奨ルート所要時間計算：普通車において最適化した値にて計算 ※旧来値：0 に比べ同じ経路でのルート所要時間は平均的に短時間に計算されます。横付け考慮：あり ※最適化の結果、横付けしない結果になる場合があります。

※ルート所要時間計算に用いる値は、料金車種,詳細車種パラメータの指定による変化はありません。

from

○

出発地点
検索するルートの出発地点を緯度経度で指定します。
from,toの直線距離が50m未満の場合、検索失敗となります。
本項目は必須項目であるため、未指定の場合はエラーとなります。

○

到着地点
検索するルートの到着地点を緯度経度で指定します。
from,toの直線距離が50m未満の場合、検索失敗となります。
本項目は必須項目であるため、未指定の場合はエラーとなります。

mpoints

経由地点
検索するルートの経由地点を緯度経度で指定します。
最大20点まで複数値指定できます。

fromtype

general

出発・到着地点引き込み優先タイプ
引き込みを優先する出発・到着地点の道路を指定します。

指定値	説明
general	一般道路を優先して引き込みます
highway	高速道路を優先して引き込みます
all	全ての道路に引き込みます

※高速道路のSA/PA等の指定をしたい場合は、highway やall をご指定ください。

totype

general

mpointstype

全て
general

経由地点引き込み優先タイプ
引き込みを優先する経由地点の道路を複数値で指定します。
本パラメータを指定した場合は、その指定個数とリクエストパラメータmpointsの経由地点数が一致する必要があります。

指定値	説明
general	一般道路を優先して引き込みます
highway	高速道路を優先して引き込みます
all	全ての道路に引き込みます

※高速道路のSA/PA等の指定をしたい場合は、highway やall をご指定ください。

datum

TOKYO

測地系
入出力緯度経度の測地系を指定します。

tolltype

normal

料金車種
指定された車種で通行料金算出を行います。
本パラメータで指定された値は、ルート検索時の車種別規制考慮と、車のサイズを考慮したルート検索には影響しません。
ルート検索時の車種別規制考慮をする場合は、詳細車種(cardetailinfo)を指定ください。
車のサイズを考慮したルート検索は、車高(height)、車幅(width)、車重(weight)を指定ください。

指定値	説明
light	軽自動車
normal	普通車
middle	中型車
large	大型車
big	特大車

height

車高
車高を0～65534の整数で指定します。(単位:cm)
本パラメータを指定すると道路情報を考慮し、車高による車両制限を加味したルート検索を行います。
無指定時は車高による車両制限は加味されません。
※目的地までの通行可能な経路がない場合、通行不可な道路を含む経路を返します。

width

車幅
車幅を0～65534の整数で指定します。(単位:cm)
本パラメータを指定すると道路情報を考慮し、車幅による車両制限を加味したルート検索を行います。
無指定時は車幅による車両制限は加味されません。
※目的地までの通行可能な経路がない場合、通行不可な道路を含む経路を返します。

weight

車重
車重を0～65534の整数で指定します。(単位:kg)
本パラメータを指定すると道路情報を考慮し、車重による車両制限を加味したルート検索を行います。
無指定時は車重による車両制限は加味されません。
※目的地までの通行可能な経路がない場合、通行不可な道路を含む経路を返します。

smartic

スマートIC利用指定
検索時にスマートICを利用するかどうかを真偽値で指定します。

llunit

dec

緯度経度形式
入出力緯度経度形式を指定します。

departuretime

出発時刻指定
出発時刻を日時で指定します。
規制考慮(regulation)に対して、時刻を考慮したルート検索を行うために使用します。

cardetailinfo

詳細車種
指定された車種の規制情報を考慮してルート検索を行います。
本パラメータで指定された値は通行料金算出と、車のサイズを考慮したルート検索には影響しません。
通行料金算出に車種指定をする場合は、料金車種(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	中型貨物自動車

regulation

規制考慮
詳細車種(cardetailinfo)で指定された車種と指定された規制情報を考慮してルート検索を行います。
下記のパラメータを指定します。複数値指定できます。
※目的地までの通行可能なルートがない場合、通行不可な道路を含むルートを返します。
指定日時～指定日時＋65分の間の時間帯規制・季節規制を対象として考慮します。
考慮範囲は出発地点より直線距離で10km以内です。到着地点が、出発地点より10kmを超える位置にあった場合は、到着地点の規制情報は考慮されません。
※本機能を利用する場合には別途契約が必要です。

指定値	説明
season	季節規制考慮 departuretimeパラメータで指定した日時で季節規制を考慮します。 departuretimeの指定が無い場合は現在時での動作となります。
time	時間帯規制考慮 departuretimeパラメータで指定した日時で時間帯規制を考慮します。 departuretimeの指定が無い場合は現在時での動作となります。

twouturn

2段階Uターン回避
2段階Uターン回避を利用するかどうかを真偽値で指定します。
詳細車種(cardetailinfo)で指定された車種での2段階Uターンを行うルートを回避します。
2段階Uターンとは、近距離で2度の右折または左折をする地点の事を表しています。
※本機能を利用する場合には別途契約が必要です。

ferry

フェリー考慮指定
フェリーを利用するかどうかを真偽値で指定します。
なお、F指定にした場合でもフェリーを利用しないと到達不可能な場合はフェリー航路を含む結果が返却されます。

指定値	説明
T	フェリーを利用する
F	フェリーを利用しない

useline

道路形状点列データ出力指定
出力データに含まれる道路形状の点列の出力を真偽値で制御します。

指定値	説明
T	出力パラメータlineを出力します。
F	出力パラメータlineの出力を省略(nullを出力)し、データ量を削減します。

tollTBD

通行料金未提供区間制御フラグ
料金情報が提供されていない道路を回避するかどうかを真偽値で指定します。
T指定した場合、料金情報が提供されていない道路を回避します。
※目的地までの通行可能なルートがない場合、通行料金未提供の道路を含むルートを返却します。

avoidarea

矩形エリア回避
ルート検索時に迂回するエリアを緯度経度矩形範囲で指定します。
10件まで複数指定可能です。
1辺の距離が10kmを超える矩形が指定された場合、エラーとなります。
国外の緯度経度を含む矩形が指定された場合、回避対象から除外してルート検索を行います。
※該当エリアを通過しないとルートが作成できない場合、該当エリアを迂回せず通過するルートが作成されます。
※緯度経度形式で指定した値と異なる形式の緯度経度を指定した場合、動作保証対象外です。

heading

進行方向
進行方向の角度を指定します。
角度は真北を0度とし、0～359までの整数で指定します。
未指定の場合、進行方向は無視されます。
また、範囲外の値を指定した場合、エラーとなります。

出力データ

出力フォーマット

{"status":{"code": "0000",
"text": ""},
"item":[{"routeID":"THB_51cd3ca8ec05772732c40d7ada9c4da1",
"type":"0",
"distance":552,
"toll":0,
"invalidFee":false,
"time":2,
"line":[{"lat":35.6256806,"lon":139.7452033},
{"lat":35.6256764,"lon":139.7452619},
{"lat":35.6256764,"lon":139.7452619},
{"lat":35.6256561,"lon":139.74543},
{"lat":35.6256561,"lon":139.74543},
{"lat":35.6256206,"lon":139.7460022},
{"lat":35.6256206,"lon":139.7460022},
{"lat":35.6250253,"lon":139.7459411},
{"lat":35.6250253,"lon":139.7459411},
{"lat":35.6250356,"lon":139.7456358},
{"lat":35.6250356,"lon":139.7456358},
{"lat":35.6216583,"lon":139.7461167},
{"lat":35.6216583,"lon":139.7461167},
{"lat":35.621645,"lon":139.7460611},
{"lat":35.621645,"lon":139.7460611},
{"lat":35.621645,"lon":139.7460611}],
"vicsTimeStamp":null,
"tollStatus": "00000"} ....]}

キー名

データ型

説明

status

object

ステータス情報が入ります。

code

string

ステータスコードが入ります。
コード一覧については別表をご覧ください。

text

string

常に空が入ります。

item

array

ルート検索結果一覧が入ります。

routeID

string

ルートIDが入ります。ルートの詳細情報を取得するのに使用します。
なお、この値は取得後24時間まで有効となります。

type

string

検索タイプが入ります。

0	推奨ルート
1	一般道優先
2	道幅優先
3	距離優先
4	別ルート優先

distance

number

経路の大まかな距離(単位:m)が入ります。

toll

number

合計の通常料金(現金の料金)(単位:円)が入ります。
経路結果に新規開通などで料金が反映されていない区間が含まれており、
一部料金が取得できない場合はトータル料金として0が入ります。

invalidFee

boolean

料金が無効値であったかどうかを示すフラグが入ります。
料金無効値は、経路結果に新規開通などで料金が反映されていない
区間が含まれている場合に発生します。

true	料金無効値である
false	料金無効値でない

time

int

トータルの時間(単位:分)が入ります。

line

array

経路の大まかな形状が入ります。

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以上の場合

出力例

[通常出力例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/route3/drive_list?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip
&from=35.792099167,139.763894444&to=35.772690278,139.753888889&smartic=T

{"status":{"code": "0000",
"text": ""},
"item":[{"routeID":"THB_2aca576583926150c73bf5f999ad1ec7",
"type":"0",
"distance":2981,
"toll":0,
"invalidFee":false,
"time":8,
"line":[{"lat":35.7920694,"lon":139.7638769},
{"lat":35.7921092,"lon":139.7638092},
{"lat":35.7919922,"lon":139.7636947},
{"lat":35.7916869,"lon":139.7634278},
...省略,
{"lat":35.7726461,"lon":139.7538617},
{"lat":35.7726461,"lon":139.7538617}],
"vicsTimeStamp":null,
"tollStatus": "00000"},
{"routeID":"THB_2fa9f38dc6f625ef3d21e834be5313c0",
"type":"1",
"distance":2981,
"toll":0,
"invalidFee":false,
"time":8,
"line":[{"lat":35.7920694,"lon":139.7638769},
{"lat":35.7921092,"lon":139.7638092},
{"lat":35.7921092,"lon":139.7638092},
{"lat":35.7919922,"lon":139.7636947},
...省略
{"lat":35.7726461,"lon":139.7538617},
{"lat":35.7726461,"lon":139.7538617}],
"vicsTimeStamp":null,
"tollStatus": "00000"},
{"routeID":"THB_3c8b55d6a40b0623a85564a605941fbb",
"type":"2",
"distance":2978,
"toll":930,
"invalidFee":false,
"time":7,
"line":[{"lat":35.7920694,"lon":139.7638769},
...省略
{"lat":35.7726461,"lon":139.7538617}],
"vicsTimeStamp":null,
"tollStatus": "00000"},
{"routeID":"THB_1917a82d62b1193af960248981e439c1",
"type":"3",
"distance":2981,
"toll":0,
"invalidFee":false,
"time":8,
"line":[{"lat":35.7920694,"lon":139.7638769},
...省略
{"lat":35.7726461,"lon":139.7538617}],
"vicsTimeStamp":null,
"tollStatus": "00000"},
{"routeID":"THB_5b12913c0f41879a617e559ab33641b6",
"type":"4",
"distance":2951,
"toll":0,
"invalidFee":false,
"time":9,
"line":[{"lat":35.7920694,"lon":139.7638769},
...省略
{"lat":35.7726461,"lon":139.7538617}],
"vicsTimeStamp":null,
"tollStatus": "00000"}]}

[道路形状データを省略した場合]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/route3/drive_list?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip
&from=35.6778128%2C139.7703875&to=35.62560028%2C139.74103528&useline=F

{"status":{"code":"0000",
"text":""},
"item":[{"routeID":"THB_a0ba0143f62769ac89fbbae280b54da1",
"type":"0",
"distance":8240,
"toll":0,
"invalidFee":false,
"time":23,
"line":null,
"vicsTimeStamp":null,
"tollStatus": "00000"},
{"routeID":"THB_65632025b8bd86e5b0242a21db4f9a6f",
"type":"1",
"distance":8240,
"toll":0,
"invalidFee":false,
"time":23,
"line":null,
"vicsTimeStamp":null,
"tollStatus": "00000"},
{"routeID":"THB_8ac0b2ed8c173dd71362ac7001191940",
"type":"2",
"distance":7864,
"toll":0,
"invalidFee":false,
"time":25,
"line":null,
"vicsTimeStamp":null,
"tollStatus": "00000"},
{"routeID":"THB_9355ea309c1348b6c378ed846e2837bb",
"type":"3",
"distance":7864,
"toll":0,
"invalidFee":false,
"time":25,
"line":null,
"vicsTimeStamp":null,
"tollStatus": "00000"},
{"routeID":"THB_55d39be0e7b025e54aa7af447b000858",
"type":"4",
"distance":8102,
"toll":0,
"invalidFee":false,
"time":25,
"line":null,
"vicsTimeStamp":null,
"tollStatus": "00000"}]}

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

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

よくあるご質問