ルート形状取得（EV）
/shape_ev_car [GET]
基本情報
概要
電気自動車（EV）を移動手段として２地点間のルートを検索し、その結果を形状で取得します。
URL
https://{HOST}/{CID}/v1/shape_ev_car
※APIマーケットの場合はURL体系が異なります
出力形式
- GeoJSON
- JSON
対応言語
- ja
パラメータ
- 「ルート検索（EV） /route_ev_car」のうち、下記以外のパラメータを受け付けます
- power_cost（電費）
- altitude（標高考慮）
利用できないパラメータについて
本APIは以下パラメータには対応してません
・lang
- 本API独自のパラメータは以下の通りです
| パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
|---|---|---|---|---|---|---|
| no | 経路番号 | 数値 | 1対多検索、多対1検索の場合、結果の複数経路の中から出力する経路を1つ指定する必要があります 未指定の場合は一番最初の経路が選択されます |
|||
| format | 出力形式 | 文字列 | geojson | geojson：GeoJSON 形式 json：JSON 形式 |
フォーマットについて
GeoJSON は地理形状を表現する一般的なフォーマットです。
GeoJSON形式の出力結果は、/map_script で利用できます。
JSON形式の出力結果は、/map_image で利用できます。
パラメータ構成例
・出発地：東京都庁、目的地：柏駅、検索条件：有料道路利用、時間優先、出発時刻：2019年10月1日8時、ターンバイターン情報を出力、の車ルート形状をGeoJSONで取得
/shape_ev_car?start={"lat":35.689457,"lon":139.691935,"name":"東京都庁"}&goal=00007423&format=geojson&condition=toll_time&start_time=2019-10-01T08:00:00&options=turn_by_turn
パラメータ構成例（1対多ルート検索で2番目のルート形状を取得）
・出発地：東京都庁、目的地1：墨田区錦糸町付近、目的地2：港区芝公園付近、の車ルートで、2番目のルート形状をGeoJSONで取得
/shape_ev_car?start=35.689457,139.691935&goal=[{"lat":35.706822,"lon":139.813956},{"lat":35.655392,"lon":139.748642}]&no=2&format=geojson&condition=toll_time&start_time=2019-10-01T08:00:00
JSON 表現は URL エンコードをした上でリクエストしてください
レスポンス（GeoJSON）
- パラメータ「format=geojson」と指定した場合に出力されるGeoJSONオブジェクトを以下に記載します
FeatureCollectionオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 種別 | type | 文字列 | FeatureCollection を表すタイプ名'FeatureCollection'を出力 | |
| 形状に関する情報 | features | Featureオブジェクト | 〇 | |
| 形状全体のバウンディングボックス | bbox | 数値 | 〇 |
Featureオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 種別 | type | 文字列 | Feature を表すタイプ名'Feature'を出力 | |
| 形状全体のバウンディングボックス | bbox | 数値 | 〇 | |
| 形状の緯度経度情報 | geometry | Geometryオブジェクト | ||
| 形状のメタ情報 | properties | Propertyオブジェクト | ガイダンスポイント情報や線の属性などを保存 |
Geometryオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 種別 | type | 文字列 | Geometry を表すタイプ名'LineString'を出力 | |
| 緯度経度 | coordinates | カンマ区切りの緯度経度の配列 | 〇 |
Propertyオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 移動情報 | ways | 文字列 | 常に 'car'が入る | |
| 区間区分群 | section | 文字列 | 出発地/経由地/目的地のまとまりを示す | |
| 線（内側） | inline | Lineオブジェクト | ||
| 線（外側） | outline | Lineオブジェクト | ||
| 経路番号 | route_no | 文字列 | ||
| 屋内ルートフラグ | indoor | 真偽値 | ||
| 規制突破フラグ | restriction | 真偽値 | ||
| 細街路 | narrow_street | 真偽値 | ||
| 道路の幅員 | road_with_grade | 真偽値 | 次のいずれかの文字列 too_narrow：走行困難な狭さ narrow：案内上限界の狭さ broad：走行が余裕の広さ |
|
| 対面通行可否 | two_way_passable | 真偽値 |
Lineオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 線種 | line_style | 文字列 | 次のいずれかの文字列 - solid：実線 - auxiliary：補助線 |
|
| 線の幅(単位：px) | width | 文字列 | ||
| 線の色 | color | 文字列 | 色（RGB形式） | |
| 透過度 | opacity | 数値 | 透過度（0.0～1.0） | |
| 線端の形状 | strokelinecap | 文字列 | 線の両端の形状 常に'round'が入る - round：丸い線端 |
|
| 角の形状 | strokelinejoin | 文字列 | コーナーポイントの形状 常に'round'が入る - round：丸い角 |
bbox(バウンディングボックス)について
GeoJSON形式のレスポンスに含まれるはバウンディングボックスとは、形状全体を包み込む四角形の緯度経度を最高値から最低値に向かって記述したものです。
これを利用すると、形状全体が描画される尺度を/map_scriptに与えることができます。
GeoJSON形式の形状で得られる線のスタイルについて
詳細はこちらからご確認いただけます。
レスポンス（JSON）
- パラメータ「format=json」と指定した場合に出力されるJSONオブジェクトを以下に記載します
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 検索結果一覧 | items | RouteShapeオブジェクト | 〇 | |
| 単位情報 | unit | Unitオブジェクト |
RouteShapeオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| マーカー一覧 | marker | Markerオブジェクト | 〇 | |
| パス一覧 | path | Pathオブジェクト | 〇 |
Markerオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 画像の起点場所 | position | 文字列 | 次のいずれかの文字列 bottom：下 bottom_left：左下 bottom_right：右下 left：左 center：中央 right：右 top：上 top_left：左上 top_right：右上 default：デフォルト |
|
| 中心緯度経度列 | centers | Coordinateオブジェクト | 〇 |
Coordinateオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 地点の緯度 | lat | 数値 | ||
| 地点の経度 | lon | 数値 |
Pathオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 緯度経度列 | coords | カンマ区切りの緯度経度の配列 | 〇 | |
| 線の幅 | width | 数値 | ||
| 線の色 | color | 文字列 | ||
| 透過度 | opacity | 数値 | ||
| 道路種別 | road_type | 文字列 | 次のいずれかの文字列 highway：高速道路 local：一般道路 ferry：フェリー |
Unitオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 測地系 | datum | 文字列 | ||
| 緯度経度の出力形式 | coord_unit | 文字列 |
レスポンス例
・GeoJSON形式
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"bbox": [
139.691935,
35.689457,
139.692349,
35.689519
],
"geometry": {
"type": "LineString",
"coordinates": [
[
139.691935,
35.689457
],
[
・・・
],
[
139.692349,
35.689519
]
]
},
"properties": {
"ways": "car",
"section": "0001,0002,0003・・・",
"inline": {
"line_style": "auxiliary",
"color": "#BFBFBF",
"width": 7,
"opacity": 0.76,
"strokelinecap": "round",
"strokelinejoin": "round"
},
"outline": {
"line_style": "dashed",
"color": "#0A6400",
"width": 10,
"opacity": 0.5,
"strokelinecap": "round",
"strokelinejoin": "round"
},
"route_no": "1",
"indoor": false,
"restriction": false,
"narrow_street": false,
"road_width_grade": "broad",
"two_way_passable": false
}
},
{
・・・
}
],
"bbox": [
139.681577,
35.688843,
139.978135,
35.909362
]
}
・JSON形式
{
"items": [
{
"marker": [ ],
"path": [
{
"coords": [
[
35.689457,
139.691935
],
[
・・・
],
[
35.689519,
139.692349
]
],
"width": 7,
"color": "#BFBFBF",
"opacity": 0.76
},
{
・・・
}
]
}
],
"unit": {
"datum": "wgs84",
"coord_unit": "degree"
}
}
エラー情報
エラーハンドリングについて
エラーメッセージは追加/変更/削除されることがあります。
エラーハンドリングされる場合は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がJSON・交通拠点ID・座標のいずれの形式にも合致しない場合に発生します。 |
| 400 | parameter error: goal: required field | goalパラメータが未指定の場合に発生します。 |
| 400 | parameter error: goal: no definitions validate | goalがJSON・交通拠点ID・座標のいずれの形式にも合致しない場合に発生します。 |
| 400 | parameter error: start_time: not datetime format : [value] | start_timeが日時形式でない場合に発生します。 |
| 400 | parameter error: start_time: an invalid datetime: [value] | start_timeが無効な日時の場合に発生します。 |
| 400 | parameter error: start_time: ['goal_time'] must not be present with 'start_time' | start_timeとgoal_timeを同時に指定した場合に発生します。 |
| 400 | parameter error: goal_time: not datetime format : [value] | goal_timeが日時形式でない場合に発生します。 |
| 400 | parameter error: goal_time: an invalid datetime: [value] | goal_timeが無効な日時の場合に発生します。 |
| 400 | parameter error: goal_time: ['start_time'] must not be present with 'goal_time' | goal_timeとstart_timeを同時に指定した場合に発生します。 |
| 400 | parameter error: via: not json format : [value] | viaがJSON形式でない場合に発生します。 |
| 400 | parameter error: via_type: unallowed value [value] | via_typeが無効な値の場合に発生します。 |
| 400 | parameter error: via_type: field 'via' is required | via_typeを指定したがviaが未指定の場合に発生します。 |
| 400 | parameter error: condition: unallowed value [value] | conditionが無効な値の場合に発生します。 |
| 400 | parameter error: order: unallowed value [value] | orderが無効な値の場合に発生します。 |
| 400 | parameter error: use_traffic: an invalid item: [item] | use_trafficに無効な値が含まれる場合に発生します。 |
| 400 | parameter error: uid: min length is 1 | uidが空文字の場合に発生します。 |
| 400 | parameter error: uid: max length is 50 | uidが50文字を超える場合に発生します。 |
| 400 | parameter error: use_road: an invalid category: [value] | use_roadに無効な道路IDが含まれる場合に発生します。 |
| 400 | parameter error: unuse_road: an invalid category: [value] | unuse_roadに無効な道路IDが含まれる場合に発生します。 |
| 400 | parameter error: options: an invalid item: [item] | optionsに無効な値が含まれる場合に発生します。 |
| 400 | parameter error: format: unallowed value [value] | formatが無効な値の場合に発生します。 |
| 400 | parameter error: smart_ic: unallowed value [value] | smart_icが無効な値の場合に発生します。 |
| 400 | parameter error: ferry: unallowed value [value] | ferryが無効な値の場合に発生します。 |
| 400 | parameter error: wide: unallowed value [value] | wideが無効な値の場合に発生します。 |
| 400 | parameter error: etc: unallowed value [value] | etcが無効な値の場合に発生します。 |
| 400 | parameter error: avoid_etc_only: unallowed value [value] | avoid_etc_onlyが無効な値の場合に発生します。 |
| 400 | parameter error: datum: unallowed value [value] | datumが無効な値の場合に発生します。 |
| 400 | parameter error: coord_unit: unallowed value [value] | coord_unitが無効な値の場合に発生します。 |
| 400 | parameter error: coord_adjustment: unallowed value [value] | coord_adjustmentが無効な値の場合に発生します。 |
| 400 | start and goal are both multiple. | startとgoalの両方がリスト形式の場合に発生します。 |
| 400 | coordinate or node or ic is required | start/goalのJSON内にic・node・lat・lonのいずれも含まれていない場合に発生します。 |
| 400 | invalid list size | start/goalのリスト要素数が0または10を超える場合に発生します。 |
| 400 | list item must be coordinate | 多対一検索時にリスト内にnode・ic・spotが含まれている場合に発生します。 |
| 400 | coordinate is required | 多対一検索時にリスト内にlat・lonが含まれていない場合に発生します。 |
| 400 | parameter error: lat: an invalid latitude: [value] | start/goal/viaのJSON内のlatが無効な緯度の場合に発生します。 |
| 400 | parameter error: lat: depends on these values: | start/goalのJSON内でlatのみ指定しlonが未指定の場合に発生します。 |
| 400 | parameter error: lon: an invalid longitude: [value] | start/goal/viaのJSON内のlonが無効な経度の場合に発生します。 |
| 400 | parameter error: lon: depends on these values: | start/goalのJSON内でlonのみ指定しlatが未指定の場合に発生します。 |
| 400 | parameter error: node: an invalid code: [value] | start/goalのJSON内のnodeが無効な交通拠点IDの場合に発生します。 |
| 400 | parameter error: ic: ['lat', 'lon', 'node'] must not be present with 'ic' | start/goalのJSON内でicとlat/lon/nodeを同時に指定した場合に発生します。 |
| 400 | parameter error: spot: an invalid code: [value] | start/goalのJSON内のspotが無効なスポットコードの場合に発生します。 |
| 400 | parameter error: spot: depends on these values: | start/goalのJSON内でspotを指定したがlat/lonが未指定の場合に発生します。 |
| 400 | parameter error: road-type: unallowed value [value] | start/goalのJSON内のroad-typeが無効な値の場合に発生します。 |
| 400 | parameter error: angle: min value is 0 | start/goalのJSON内のangleが0未満の場合に発生します。 |
| 400 | parameter error: angle: max value is 360 | start/goalのJSON内のangleが360を超える場合に発生します。 |
| 400 | parameter error: park-side: unallowed value [value] | start/goalのJSON内のpark-sideが無効な値の場合に発生します。 |
| 400 | via must be in json format | viaのJSONパースに失敗した場合に発生します。 |
| 400 | via must be in array format | viaがリスト形式でない場合に発生します。 |
| 400 | goal or start is multiple | via使用時にstart/goalがリスト形式の場合に発生します。 |
| 400 | coordinate or ic is required | viaのJSON内にlat・lon・icのいずれも含まれていない場合に発生します。 |
| 400 | parameter error: lat: required field | viaのJSON内でlat（arrival-timesのfrom/to含む）が未指定の場合に発生します。 |
| 400 | parameter error: lon: required field | viaのJSON内でlonが未指定の場合に発生します。 |
| 400 | parameter error: stay-time: min value is 0 | viaのJSON内のstay-timeが0未満の場合に発生します。 |
| 400 | parameter error: stay-time: max value is 720 | viaのJSON内のstay-timeが720を超える場合に発生します。 |
| 400 | parameter error: intersection: an invalid code: [value] | viaのJSON内のintersectionが無効な交差点IDの場合に発生します。 |
| 400 | parameter error: intersection: depends on these values: | viaのJSON内でintersectionを指定したがlat/lonが未指定の場合に発生します。 |
| 400 | parameter error: ic: ['lat', 'lon'] must not be present with 'ic' | viaのJSON内でicとlat/lonを同時に指定した場合に発生します。 |
| 400 | parameter error: ic-passing-type: unallowed value [value] | viaのJSON内のic-passing-typeが無効な値の場合に発生します。 |
| 400 | parameter error: ic-passing-type: depends on these values: | viaのJSON内でic-passing-typeを指定したがicが未指定の場合に発生します。 |
| 400 | parameter error: from: required field | viaのarrival-times内のfromが未指定の場合に発生します。 |
| 400 | parameter error: from: not datetime format : [value] | viaのarrival-times内のfromが日時形式でない場合に発生します。 |
| 400 | parameter error: from: an invalid datetime: [value] | viaのarrival-times内のfromが無効な日時の場合に発生します。 |
| 400 | parameter error: to: required field | viaのarrival-times内のtoが未指定の場合に発生します。 |
| 400 | parameter error: to: not datetime format : [value] | viaのarrival-times内のtoが日時形式でない場合に発生します。 |
| 400 | parameter error: to: an invalid datetime: [value] | viaのarrival-times内のtoが無効な日時の場合に発生します。 |
| 400 | from_time must be earlier than to_time | viaのarrival-timesのfromがtoより後の場合に発生します。 |
| 400 | list size (via) is too small | arrival-times使用時にvia地点数が2未満の場合に発生します。 |
| 400 | arrival-times must use with optimal(via_type) | arrival-times使用時にvia_typeがspecifiedの場合に発生します。 |
| 400 | invalid stay-time | 最適順/経由地間最適順でvia滞在時間が300を超える場合に発生します。 |
| 400 | invalid via_type | 交差点ID指定時にvia_typeがspecified以外の場合に発生します。 |
| 400 | too many intersections | viaに交差点IDが3つ以上含まれる場合に発生します。 |
| 400 | list size is too large | via地点数が上限を超える場合に発生します。 |
| 400 | outside of the valid range | via地点が有効範囲外の場合に発生します。 |
| 400 | invalid road id | use_roadとunuse_roadに同じ道路IDが指定された場合に発生します。 |
| 400 | bad usage on this contract : use_traffic | use_traffic使用時に必要なオプションが設定されていない場合に発生します。 |
| 400 | bad usage on this contract : Multilingual | lang パラメータを指定したが、契約で多言語オプションが有効化されていない場合に発生します。 |
| 400 | bad usage on this contract : useZone30 | use_bywayをtrue指定時に必要なオプションが設定されていない場合に発生します。 |
| 400 | uid is required. | use_traffic=vics指定時にuidおよびx-ntj-uidヘッダーが未指定の場合に発生します。 |
| 400 | start_time or goal_time is required. | use_traffic=vics/probe指定時にstart_time・goal_timeが未指定の場合に発生します。 |
| 400 | order | 1対1検索時にorderパラメータを指定した場合に発生します。 |
| 400 | no | 1対1検索時にnoパラメータが2以上の場合に発生します。 |