ルート形状取得（バイク）
/shape_motorcycle [GET]
基本情報
概要
バイクを移動手段として２地点間のルートを検索し、その結果を形状で取得します。
URL
https://{HOST}/{CID}/v1/shape_motorcycle
※APIマーケットでは提供しておりません
出力形式
- GeoJSON
- JSON
対応言語
- ja
パラメータ
- 「ルート検索（バイク） /route_motorcycle」と同等のパラメータを受け付けます
- 本API独自のパラメータは以下の通りです
| パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
|---|---|---|---|---|---|---|
| no | 経路番号 | 数値 | 1対多検索、多対1検索の場合、結果の複数経路の中から出力する経路を1つ指定する必要があります 未指定の場合は一番最初の経路が選択されます |
|||
| format | 出力形式 | 文字列 | geojson | geojson：GeoJSON 形式 json：JSON 形式 |
フォーマットについて
GeoJSON は地理形状を表現する一般的なフォーマットです。
GeoJSON形式の出力結果は、/map_script で利用できます。
JSON形式の出力結果は、/map_image で利用できます。
パラメータ構成例
・出発地：東京都庁、目的地：柏駅、排気量：250cc、検索条件：有料道路利用、時間優先、出発時刻：2020年10月1日8時、ターンバイターン情報を出力、のルート形状をGeoJSONで取得
/shape_motorcycle?start={"lat":35.689457,"lon":139.691935,"name":"東京都庁"}&goal=00007423&displacement=250&format=geojson&condition=toll_time&start_time=2020-10-01T08:00:00&options=turn_by_turn
パラメータ構成例（1対多ルート検索で2番目のルート形状を取得）
・出発地：東京都庁、目的地1：墨田区錦糸町付近、目的地2：港区芝公園付近、排気量50ccのバイクルートで、2番目のルート形状をGeoJSONで取得
/shape_motorcycle?start=35.689457,139.691935&goal=[{"lat":35.706822,"lon":139.813956},{"lat":35.655392,"lon":139.748642}]&no=2&displacement=50&format=geojson&condition=toll_time&start_time=2020-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 | 文字列 | ||
| 区間区分群 | 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.692346,
35.689519
],
"geometry": {
"type": "LineString",
"coordinates": [
[
139.691935,
35.689457
],
[
139.692346,
35.689519
]
]
},
"properties": {
"ways": "car",
"section": "0001,0002,0003,0004,0005,0006,0007,0008,0009,0010,0011,0012,0013,0014,0015",
"inline": {
"line_style": "auxiliary",
"width": 5,
"color": "#D3D3D3",
"opacity": 1.0,
"strokelinecap": "round",
"strokelinejoin": "round"
},
"outline": {
"line_style": "solid",
"width": 10,
"color": "#898989",
"opacity": 1.0,
"strokelinecap": "round",
"strokelinejoin": "round"
},
"route_no": "1"
}
},
{
・・・
}
],
"bbox": [
139.681568,
35.688847,
139.978127,
35.909366
]
}
・JSON形式
{
"items": [
{
"marker": [],
"path": [
{
"coords": [
[
35.689457,
139.691935
],
[
35.689519,
139.692346
]
],
"width": 7,
"color": "#BFBFBF",
"opacity": 0.76
},
{
・・・
}
]
}
],
"unit": {
"datum": "wgs84",
"coord_unit": "degree"
}
}