道路形状取得

/shape_road [GET]

基本情報

概要

道路IDをもとに道路情報を検索し、結果を形状で取得します。

URL

https://{HOST}/{CID}/v1/shape_road

※APIマーケットの場合はURL体系が異なります

出力形式

GeoJSON

対応言語

ja

パラメータ

パラメータ名	必須	概要	型名	デフォルト値	上下限/選択値	備考
id	✔	道路ID	文字列			半角数字6桁以内で指定 /road のレスポンスの id を指定します
datum		緯度経度の測地系	文字列	wgs84	wgs84：世界測地系 tokyo：旧日本測地系
coord_unit		出力データに含まれる緯度経度の単位	文字列	degree	degree：度表記の10進法 millisec：ミリ秒表記

フォーマットについて

GeoJSON は地理形状を表現する一般的なフォーマットです。
GeoJSON形式の出力結果は、/map_script で利用できます。

パラメータ構成例

・道路IDが「1」の道路の形状をGeoJSONで取得

/shape_road?id=1

レスポンス

FeatureCollectionオブジェクト

名称	レスポンス名	型名	配列	説明
種別	type	文字列		FeatureCollection を表すタイプ名'FeatureCollection'を出力
形状に関する情報	features	Featureオブジェクト	〇
形状全体のバウンディングボックス	bbox	数値	〇

Featureオブジェクト

名称	レスポンス名	型名	配列	説明
種別	type	文字列		Feature を表すタイプ名'Feature'を出力
形状全体のバウンディングボックス	bbox	数値	〇
形状の緯度経度情報	geometry	Geometryオブジェクト

Geometryオブジェクト

名称	レスポンス名	型名	配列	説明
種別	type	文字列		Geometry を表すタイプ名'LineString'を出力
緯度経度	coordinates	Coordinateオブジェクト	〇

Coordinateオブジェクト

名称	レスポンス名	型名	配列	説明
地点の緯度	lat	数値
地点の経度	lon	数値

・GeoJSON形式

{
    "type": "FeatureCollection",
    "features": [
        {
            "type": "Feature",
            "bbox": [
                141.400469,
                43.15575,
                141.401434,
                43.161971
            ],
            "geometry": {
                "type": "LineString",
                "coordinates": [
                    [
                        141.400469,
                        43.15575
                    ],
                    [
                        141.400821,
                        43.157934
                    ],
                    [
                        141.400821,
                        43.157934
                    ],
                    [
                        141.401014,
                        43.159184
                    ],
                    [
                        141.401014,
                        43.159184
                    ],
                    [
                        141.40115,
                        43.160073
                    ],
                    [
                        141.40115,
                        43.160073
                    ],
                    [
                        141.401298,
                        43.161036
                    ],
                    [
                        141.401298,
                        43.161036
                    ],
                    [
                        141.401434,
                        43.161971
                    ]
                ]
            },
        }
    ],
    "bbox": [
        141.400469,
        43.15575,
        141.401434,
        43.161971
    ]
}

エラー情報

エラーハンドリングについて

エラーメッセージは追加/変更/削除されることがあります。
エラーハンドリングされる場合はHTTPステータスコードをもとにご対応ください。
共通エラーについてはこちらをご参照ください。

HTTPステータス	エラーメッセージ	発生理由
405	"This http method is invalid : POST"（等）	許可されていないHTTPメソッドでアクセスされた場合に発生します。
400	parameter error: id: "required field"	必須パラメータである id が指定されていない場合に発生します。
400	parameter error: id: "an invalid id: {value}"	id に空文字を指定した場合や、半角数字で6桁以内の値以外を指定した場合に発生します。
400	parameter error: datum: "unallowed value {value}"	datum に wgs84, tokyo 以外の不正な値を指定した場合に発生します。
400	parameter error: coord_unit: "unallowed value {value}"	coord_unit に degree, millisec 以外の不正な値を指定した場合に発生します。