歩行者ルート検索

API名:

route/walk

概要:

出発地点と到着地点を指定して歩行者用のルートを検索します。

URI:

https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/route/walk

<API使用例>
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/route/walk?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&from=35.664,139.756&to=35.660,139.754

リクエストパラメータ

パラメータ

必須

デフォルト値

説明

from

○

出発地点
検索するルートの出発地点を緯度経度で指定します。
本項目は必須項目であるため、未指定の場合はエラーとなります。

○

到着地点
検索するルートの到着地点を緯度経度で指定します。
本項目は必須項目であるため、未指定の場合はエラーとなります。

datum

TOKYO

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

mpoints

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

searchtype

time

優先タイプ
ルート検索時の優先タイプを指定します。

dist	距離優先で検索します。
time	時間優先で検索します。
easy	楽な道優先で検索します。※
roof	屋根がある道優先で検索します。
highway	幹線道路を優先で検索します。

※楽な道とは、階段をできるだけ利用しないような道を指します。

maxdist

検索距離上限指定
検索距離の上限を指定します。

5	5km
10	10km

station
※非推奨

駅フラグ指定
出発地点、到着地点を駅とするかどうかを指定します。
※本パラメータは非推奨です。startflag及びendflagの使用をお奨めします。

start	出発地点を駅に設定します。
end	到着地点を駅に設定します。
bothon	出発地点、到着地点を共に駅とする。
bothoff	出発地点、到着地点を共に駅としない。

startflag

station

出発地点フラグ
出発地点から最初に何の構造物の出入口を経由してルート検索を行うかを指定します。
リクエストパラメータ station と同時指定はできません。

station	出発地点が駅代表点の近くであった場合に、その駅の出入口を経由します。近くに駅が無い場合は none 指定と同様に最寄道路を経由しての通常のルートとなります。
facility	出発地点が施設代表点の近くであった場合に、その施設の出入口を経由します。近くに施設が無い場合は none 指定と同様に最寄道路を経由しての通常のルートとなります。
none	出入口を使用しない通常のルート検索に設定します。

endflag

station

到着地点フラグ
到着地点から最初に何の構造物の出入口を経由してルート検索を行うかを指定します。
リクエストパラメータ station と同時指定はできません。

station	到着地点が駅代表点の近くであった場合に、その駅の出入口を経由します。近くに駅が無い場合は none 指定と同様に最寄道路を経由しての通常のルートとなります。
facility	到着地点が施設代表点の近くであった場合に、その施設の出入口を経由します。近くに施設が無い場合は none 指定と同様に最寄道路を経由しての通常のルートとなります。
none	出入口を使用しない通常のルート検索に設定します。

crossinfo

同一交差点区間数取得指定
誘導情報の同一交差点区間数を取得するかどうかを真偽値で指定します。

turninginfo

右左折情報取得指定
誘導情報の右左折情報を取得するかどうかを真偽値で指定します。

crossname

交差点名称情報取得指定
誘導情報の交差点名称情報を取得するかどうかを真偽値で指定します。

stationname

駅出入口名称情報取得指定
誘導情報の駅出入口名称情報を取得するかどうかを真偽値で指定します。

crossmark

交差点目印情報取得指定
誘導情報の交差点目印情報を取得するかどうかを真偽値で指定します。

llunit

dec

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

出力データ

出力フォーマット

{"status":{"code":"0000",
"text":"正常終了"},
"route":{"distance":499,
"link":[{"type":"通常通路",
"typeCode":0,
"structureType":"通常",
"structureTypeCode":0
"roof":false,
"passage": true
"viaPoint" false,
"distance":30,
"line":{"latlon":[35.664024722222,139.75595083333,35.663896944444,139.75588416667,35.663763611111,139.7558175]},
"guidance":{"nextDist":23,
"crossInfo":3,
"turningInfo":{"angle":92,
"in":-1,
"out":2},
"crossName":[{"type":{"code":0,
"text":"交差点"},
"text":"田町駅西口",
"kana":"タマチエキニシグチ"}...],
"crossMark":[{"type":{"code":167,
"text":"コンビニ"},
"point":{"lat":35.6437597,
"lon":139.75052}}...],
"detailInfo": [{"detailid":"01",
"level":2,
"detailname":"JR田町駅",
"floorname":２階}],
...
]
}
}

キー名

データ型

説明

status

object

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

code

string

ステータスコードが入ります。

0000	正常終了
8001	各始点・経由点・終点間の距離が近すぎる
8101	各始点・経由点・終点間の距離が遠すぎる(目安:10km)
0112	経路探索失敗

text

string

ステータス内容に関するテキスト情報が入ります。

route

object

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

distance

number

トータルの距離(単位:m)が入ります。

link

array

リンク情報の配列が入ります。

type

string

当該リンクの通路種別名(通常道路/横断歩道/歩道橋/建物内通路等)が入ります。

typeCode

number

当該リンクの通路種別コードが入ります。

structureType

string

当該リンクの構造種別名(階段/エスカレーター/スロープ等)が入ります。

structureTypeCode

number

当該リンクの構造種別コードが入ります。

roof

boolean

当該リンクが屋根のある通路であればtrueが入ります。

passage

boolean

当該リンクが通路であればtrueが入ります。

viaPoint

boolean

当該リンクが立ち寄り経由地であればtrueが入ります。

distance

number

当該リンクの距離(メートル)が入ります。

line

object

当該リンクの形状データが入ります。

latlon

array

形状ポリラインデータが入ります。

guidance

object

当該リンクの誘導情報が入ります。

nextDist

number

次の誘導情報までの距離(単位:m)が入ります。
データがない場合はnullが入ります。

crossInfo

number

同一交差点とみなされた区間数が入ります。
データがない場合はnullが入ります。

turningInfo

object

右左折情報が入ります。データがない場合はnullが入ります。

angle

number

進入道路に対する脱出道路の方向(単位:°)が入ります。進入道路の直進方向を0度とし右回りに0～359度で表現されます。

number

当該リンクを「0」とした右左折開始リンクの位置が入ります。
当該リンクの二つ前に右左折開始リンクがある場合は「-2」が入ります。
当該リンクが右左折開始リンクである場合は「0」が入ります。

out

number

当該リンクを「0」とした右左折終了リンクの位置が入ります。
当該リンクの二つ後に右左折終了リンクがある場合、「2」が入ります。
当該リンクが右左折終了リンクである場合は「0」が入ります。

crossName

array

当該リンクの名称情報の配列が入ります。
データがない場合は空配列が入ります。

type

object

名称種別情報が入ります。

code

number

名称種別コードが入ります。

0	交差点
1	駅出入口

text

string

名称種別コードのテキスト情報が入ります。

text

string

名称種別のテキスト情報が入ります。

kana

string

名称種別のテキストカナ情報が入ります。

crossMark

array

当該リンクの交差点目印情報の配列が入ります。
データがない場合は空配列が入ります。

type

object

交差点目印種別情報が入ります。

code

number

目印種別コードが入ります。

71	代表(金融関連)
167	コンビニ
150	代表(ファミレス)
196	代表(ファーストフード)

text

string

目印種別コードのテキスト情報が入ります。

point

object

交差点目印の代表点緯度経度が入ります。

detailInfo

array

詳細図情報が入ります。
情報が無い場合、空の配列が入ります。

detailid

string

詳細図シーケンス番号が入ります。

level

number

階層レベルが入ります。

detailname

array

詳細図名称の情報が入ります。

floorname

array

フロア名称の情報が入ります。

出力例

[通常出力例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/route/walk?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&crossinfo=T&turninginfo=T&crossname=T&stationname=T&crossmark=T
&from=35.678649929,139.770147779&to=35.678256751,139.770474831&searchtype=time&mpoints=&maxdist=5&station=bothoff

{
    "status": {
        "code": "0000",
        "text": "正常終了"
    },
    "route": {
        "distance": 82,
        "link": [
            {
                "type": "通路外",
                "typeCode": 15,
                "structureType": "通常",
                "structureTypeCode": 0,
                "roof": false,
                "passage": false,
                "viaPoint": false,
                "distance": 4,
                "line": {
                    "latlon": [
                        35.67865,
                        139.7701472,
                        35.6786139,
                        139.7701333
                    ]
                },
                "guidance": {
                    "nextDist": null,
                    "crossInfo": null,
                    "turningInfo": null,
                    "crossName": [],
                    "crossMark": [],
                    "detailInfo": []
                }
            },
            {
                "type": "改札内通路",
                "typeCode": 10,
                "structureType": "通常",
                "structureTypeCode": 0,
                "roof": true,
                "passage": true,
                "viaPoint": false,
                "distance": 3,
                "line": {
                    "latlon": [
                        35.6786139,
                        139.7701333,
                        35.6786083,
                        139.7701333,
                        35.6786028,
                        139.7701611
                    ]
                },
                "guidance": {
                    "nextDist": null,
                    "crossInfo": null,
                    "turningInfo": null,
                    "crossName": [],
                    "crossMark": [],
                    "detailInfo": []
                }
            },
            {
                "type": "改札内通路",
                "typeCode": 10,
                "structureType": "通常",
                "structureTypeCode": 0,
                "roof": true,
                "passage": true,
                "viaPoint": false,
                "distance": 10,
                "line": {
                    "latlon": [
                        35.6786028,
                        139.7701611,
                        35.6785861,
                        139.7701556,
                        35.6785778,
                        139.7701861,
                        35.6785361,
                        139.7701694,
                        35.6785417,
                        139.7701389
                    ]
                },
                "guidance": {
                    "nextDist": 10,
                    "crossInfo": null,
                    "turningInfo": null,
                    "crossName": [],
                    "crossMark": [],
                    "detailInfo": [
                        {
                            "detailid": "5",
                            "level": 1,
                            "detailname": [
                                "ＪＲ東京駅"
                            ],
                            "floorname": [
                                "２階"
                            ]
                        }
                    ]
                }
            },
            {
                "type": "改札内通路",
                "typeCode": 10,
                "structureType": "通常",
                "structureTypeCode": 0,
                "roof": true,
                "passage": true,
                "viaPoint": false,
                "distance": 2,
                "line": {
                    "latlon": [
                        35.6785417,
                        139.7701389,
                        35.6785194,
                        139.7701278
                    ]
                },
                "guidance": {
                    "nextDist": 5,
                    "crossInfo": null,
                    "turningInfo": null,
                    "crossName": [],
                    "crossMark": [],
                    "detailInfo": [
                        {
                            "detailid": "5",
                            "level": 1,
                            "detailname": [
                                "ＪＲ東京駅"
                            ],
                            "floorname": [
                                "２階"
                            ]
                        }
                    ]
                }
            }, ...
            {
                "type": "改札内通路",
                "typeCode": 10,
                "structureType": "通常",
                "structureTypeCode": 0,
                "roof": true,
                "passage": true,
                "viaPoint": false,
                "distance": 6,
                "line": {
                    "latlon": [
                        35.6782861,
                        139.7704139,
                        35.6782833,
                        139.7704194,
                        35.6782778,
                        139.7704194,
                        35.6782639,
                        139.770475
                    ]
                },
                "guidance": {
                    "nextDist": null,
                    "crossInfo": null,
                    "turningInfo": null,
                    "crossName": [],
                    "crossMark": [],
                    "detailInfo": [
                        {
                            "detailid": "5",
                            "level": 0,
                            "detailname": [
                                "ＪＲ東京駅"
                            ],
                            "floorname": [
                                "１階"
                            ]
                        }
                    ]
                }
            },
            {
                "type": "通路外",
                "typeCode": 15,
                "structureType": "通常",
                "structureTypeCode": 0,
                "roof": false,
                "passage": false,
                "viaPoint": false,
                "distance": 1,
                "line": {
                    "latlon": [
                        35.6782639,
                        139.770475,
                        35.6782556,
                        139.7704722
                    ]
                },
                "guidance": {
                    "nextDist": null,
                    "crossInfo": null,
                    "turningInfo": null,
                    "crossName": [],
                    "crossMark": [],
                    "detailInfo": []
                }
            }
        ]
    }
}

[ルート検索に失敗した例]
ルート検索に失敗した場合にはstatus->codeの値が 0000 以外となり、ルート結果がnullとなります。

{
    "status": {
        "code": "8101",
        "text": "各始点・経由点・終点間の距離が遠過ぎる"
    },
    "route": null
}