ガイドAPIリファレンス
ガイド

GET /routesエンドポイント

必須のリクエストパラメーター

  • origin:出発地点の座標と、屋内地図IDおよび対応するフロアIDが含まれます
  • destination: 目的地点の座標と、屋内地図IDおよび対応するフロアIDが含まれます。経由地オプションを停止時間 (秒) として設定することもできます。
  • transportMode:移動モード。サポートされている移動モードは次のとおりです。
    • pedestrian
    • car
    • taxi
    • scooter

任意のリクエストパラメーター

  • pedestrian[speed]:歩行者速度を0.5~2 m/秒の範囲でカスタマイズ可能
  • vehicle[speed]:車両速度を2~5 m/秒の範囲でカスタマイズ可能
  • vehicle[enable]:指定された車両モードで、走行の開始・終了、または全行程を走行するためのオプションをユーザーに提供します。使用可能な値は以下のとおりです。
    • routeHead
    • routeTail
    • entireRoute
  • routingMode:ルート検索モード (最速ルートまたは最短ルートを指定)。使用可能な値は以下のとおりです。
    • fast
    • short
  • avoid[features]:ユーザーがルート上の特定のフィーチャーを回避する場合に使用します。使用可能な値は以下のとおりです。
    • elevator
    • escalator
    • movingWalkway
    • ramp
    • stairs
    • pedestrianRamp
    • carLift
    • driveRamp
    • elevatorBank
  • via:ポイントの座標、屋内地図ID、対応するレベルID、および通過フラグや停止時間 (秒) などのその他の経由地オプションが含まれている、出発地と目的地の間の中間経由地配列。ユーザーからの入力として、最大5つの経由地を使用できます。

歩行者用ルートの例

歩行者モードのURLサンプルリクエスト

https://indoor.router.hereapi.com/v1/routes?\
transportMode=pedestrian&\
pedestrian[speed]=1&\
origin=52.5306348,13.3848528;indoorMapId=indoormap-00000000-0000-4000-a000-000000025556;levelId=level-61784&\
destination=52.5308726,13.3845703;indoorMapId=indoormap-00000000-0000-4000-a000-000000025556;levelId=level-61782&\
avoid[features]=stairs&routingMode=fast

階段を通る歩行者ルートのサンプルレンダリング

ルート1 ルート2

歩行者専用ルートのサンプル出力

{
    "routes": [
        {
            "sections": [
                {
                    "type": "pedestrian",
                    "departure": {
                        "place": {
                            "type": "indoor",
                            "id": "indoormap-00000000-0000-4000-a000-000000025556",
                            "location": {
                                "lat": 52.5307934,
                                "lng": 13.3854177,
                                "lvl": 2,
                                "levelId": "level-61422"
                            }
                        }
                    },
                    "arrival": {
                        "place": {
                            "type": "indoor",
                            "id": "indoormap-00000000-0000-4000-a000-000000025556",
                            "location": {
                                "lat": 52.5309169,
                                "lng": 13.385328,
                                "lvl": 3,
                                "levelId": "level-61423"
                            }
                        }
                    },
                    "polyline": "BX8ho-pfi-5p_HElElfAyHtFA8kB5aAsEjDA4SzNAuIhGAmLjIAuEnDApNxxBApM-IAyEiRAACAAAEhF5SBmM7IA6NqzBA1EsDAhLgIA0FieA",
                    "actions": [
                        {
                            "offset": 0,
                            "action": "depart",
                            "length": 0,
                            "duration": 0
                        },
                        {
                            "offset": 0,
                            "action": "leave",
                            "length": 3.46,
                            "duration": 3.5,
                            "space": {
                                "category": "FACILITY",
                                "type": "ROOM",
                                "name": "Copy/Print"
                            }
                        },
                        {
                            "offset": 0,
                            "action": "enter",
                            "length": 0,
                            "duration": 0,
                            "space": {
                                "category": "STRUCTURE",
                                "type": "HALLWAY"
                            }
                        },
                        {
                            "offset": 1,
                            "action": "turn",
                            "length": 17.82,
                            "duration": 17.8,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 8,
                            "action": "turn",
                            "length": 5.87,
                            "duration": 5.9,
                            "direction": "left",
                            "severity": "quite"
                        },
                        {
                            "offset": 9,
                            "action": "turn",
                            "length": 2.4,
                            "duration": 2.4,
                            "direction": "left",
                            "severity": "quite"
                        },
                        {
                            "offset": 9,
                            "action": "enter",
                            "length": 0,
                            "duration": 0,
                            "space": {
                                "category": "LEVEL_CONNECTOR",
                                "type": "STAIRS"
                            }
                        },
                        {
                            "offset": 10,
                            "action": "turn",
                            "length": 2.02,
                            "duration": 2,
                            "direction": "left",
                            "severity": "quite"
                        },
                        {
                            "offset": 11,
                            "action": "changeLevel",
                            "length": 2.23,
                            "duration": 27.3,
                            "levelConnector": "stairs",
                            "levelDelta": 1
                        },
                        {
                            "offset": 13,
                            "action": "turn",
                            "length": 2.38,
                            "duration": 2.4,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 13,
                            "action": "leave",
                            "length": 0,
                            "duration": 0,
                            "space": {
                                "category": "LEVEL_CONNECTOR",
                                "type": "STAIRS"
                            }
                        },
                        {
                            "offset": 13,
                            "action": "enter",
                            "length": 0,
                            "duration": 0,
                            "space": {
                                "category": "STRUCTURE",
                                "type": "HALLWAY"
                            }
                        },
                        {
                            "offset": 14,
                            "action": "turn",
                            "length": 6.07,
                            "duration": 6.1,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 15,
                            "action": "turn",
                            "length": 3.06,
                            "duration": 3.1,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 17,
                            "action": "turn",
                            "length": 3.41,
                            "duration": 3.4,
                            "direction": "left",
                            "severity": "quite"
                        },
                        {
                            "offset": 17,
                            "action": "enter",
                            "length": 0,
                            "duration": 0,
                            "space": {
                                "category": "FACILITY",
                                "type": "KITCHEN"
                            }
                        },
                        {
                            "action": "arrive",
                            "offset": 19,
                            "length": 0,
                            "duration": 0
                        }
                    ],
                    "summary": {
                        "length": 49,
                        "duration": 74
                    },
                    "transport": {
                        "mode": "pedestrian"
                    }
                }
            ]
        }
    ]
}

マルチモーダルルートの例

車両モードのURLサンプルリクエスト

https://indoor.router.hereapi.com/v1/routes?\
origin=52.53074557107664,13.384900033438564;indoorMapId=indoormap-00000000-0000-4000-a000-000000025556;levelId=level-61421&\
destination=52.53063213306504,13.38561517303418;indoorMapId=indoormap-00000000-0000-4000-a000-000000025556;levelId=level-61784&\
transportMode=car

異なるカラーコードを使用したマルチモーダルルートのサンプルレンダリング

ルート1 ルート2

マルチモーダルルートのサンプル出力

{
    "routes": [
        {
            "sections": [
                {
                    "type": "pedestrian",
                    "departure": {
                        "place": {
                            "type": "indoor",
                            "id": "indoormap-00000000-0000-4000-a000-000000025556",
                            "location": {
                                "lat": 52.5307458,
                                "lng": 13.3849022,
                                "lvl": 1,
                                "levelId": "level-61421"
                            }
                        }
                    },
                    "arrival": {
                        "place": {
                            "type": "indoor",
                            "id": "indoormap-00000000-0000-4000-a000-000000025556",
                            "location": {
                                "lat": 52.53065978,
                                "lng": 13.38502044,
                                "lvl": -1,
                                "levelId": "level-61784"
                            }
                        }
                    },
                    "polyline": "BXkkn-pf87vp_HCwM0eA_NmKAhF0DA9V-PA1C-BAnOqKAjHkFAyNyyBAiL_HAzEjRAvBlFBgBPA8DwOB_L2IAxM5uBA",
                    "actions": [
                        {
                            "offset": 0,
                            "action": "depart",
                            "length": 0,
                            "duration": 0
                        },
                        {
                            "offset": 0,
                            "action": "leave",
                            "length": 3.99,
                            "duration": 4,
                            "space": {
                                "category": "FACILITY",
                                "type": "MEETING_ROOM"
                            }
                        },
                        {
                            "offset": 0,
                            "action": "enter",
                            "length": 0,
                            "duration": 0,
                            "space": {
                                "category": "STRUCTURE",
                                "type": "HALLWAY"
                            }
                        },
                        {
                            "offset": 1,
                            "action": "turn",
                            "length": 12.65,
                            "duration": 12.6,
                            "direction": "right",
                            "severity": "heavy"
                        },
                        {
                            "offset": 7,
                            "action": "turn",
                            "length": 5.98,
                            "duration": 6,
                            "direction": "left",
                            "severity": "quite"
                        },
                        {
                            "offset": 8,
                            "action": "turn",
                            "length": 2.15,
                            "duration": 2.1,
                            "direction": "left",
                            "severity": "quite"
                        },
                        {
                            "offset": 8,
                            "action": "enter",
                            "length": 0,
                            "duration": 0,
                            "space": {
                                "category": "LEVEL_CONNECTOR",
                                "type": "STAIRS"
                            }
                        },
                        {
                            "offset": 9,
                            "action": "turn",
                            "length": 2.03,
                            "duration": 2,
                            "direction": "left",
                            "severity": "quite"
                        },
                        {
                            "offset": 10,
                            "action": "changeLevel",
                            "length": 0.63,
                            "duration": 13.1,
                            "levelConnector": "stairs",
                            "levelDelta": -1
                        },
                        {
                            "offset": 11,
                            "action": "turn",
                            "length": 0.19,
                            "duration": 12.7,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 11,
                            "action": "changeLevel",
                            "length": 0,
                            "duration": 0,
                            "levelConnector": "stairs",
                            "levelDelta": -1
                        },
                        {
                            "offset": 12,
                            "action": "turn",
                            "length": 1.72,
                            "duration": 1.7,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 13,
                            "action": "turn",
                            "length": 2.34,
                            "duration": 2.3,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 14,
                            "action": "turn",
                            "length": 5.54,
                            "duration": 5.5,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 14,
                            "action": "leave",
                            "length": 0,
                            "duration": 0,
                            "space": {
                                "category": "LEVEL_CONNECTOR",
                                "type": "STAIRS"
                            }
                        },
                        {
                            "offset": 14,
                            "action": "enter",
                            "length": 0,
                            "duration": 0,
                            "space": {
                                "category": "STRUCTURE",
                                "type": "DRIVABLE_HALLWAY"
                            }
                        },
                        {
                            "action": "arrive",
                            "offset": 15,
                            "length": 0,
                            "duration": 0
                        }
                    ],
                    "summary": {
                        "length": 37,
                        "duration": 62
                    },
                    "transport": {
                        "mode": "pedestrian"
                    }
                },
                {
                    "type": "vehicle",
                    "departure": {
                        "place": {
                            "type": "indoor",
                            "id": "indoormap-00000000-0000-4000-a000-000000025556",
                            "location": {
                                "lat": 52.53065978,
                                "lng": 13.38502044,
                                "lvl": -1,
                                "levelId": "level-61784"
                            }
                        }
                    },
                    "arrival": {
                        "place": {
                            "type": "indoor",
                            "id": "indoormap-00000000-0000-4000-a000-000000025556",
                            "location": {
                                "lat": 52.53064886,
                                "lng": 13.38560528,
                                "lvl": -1,
                                "levelId": "level-61784"
                            }
                        }
                    },
                    "polyline": "BXsul-pf4lyp_HBrEmDAxHwFAhI6FA9NkKArN2JApQ6LAmCoIA4FsVA0F6UA-FqWAuFiUAsD4MAiC2HA2FmVA6FyVAwF0UA0FgVAyF0UAuFuUAqB4EAyEgRAyF6UAwF0UA1JiHAtOwKA",
                    "actions": [
                        {
                            "offset": 15,
                            "action": "turn",
                            "length": 12.37,
                            "duration": 34.4,
                            "direction": "left",
                            "severity": "quite"
                        },
                        {
                            "offset": 21,
                            "action": "turn",
                            "length": 35.71,
                            "duration": 12.8,
                            "direction": "left",
                            "severity": "quite"
                        },
                        {
                            "offset": 38,
                            "action": "turn",
                            "length": 4.7,
                            "duration": 1.7,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 38,
                            "action": "enter",
                            "length": 0,
                            "duration": 0,
                            "space": {
                                "category": "TRAFFIC",
                                "type": "PARKING_SPOT"
                            }
                        },
                        {
                            "action": "arrive",
                            "offset": 25,
                            "length": 0,
                            "duration": 0
                        }
                    ],
                    "summary": {
                        "length": 53,
                        "duration": 49
                    },
                    "transport": {
                        "mode": "car"
                    }
                }
            ]
        }
    ]
}

ルートに経由地を追加する

サンプルリクエストURL

https://indoor.router.hereapi.com/v1/routes?\
origin=52.53051316788,13.38482607083;indoorMapId=indoormap-00000000-0000-4000-a000-000000025556;levelId=level-61422&\
destination=52.5306807972,13.38532180772;indoorMapId=indoormap-00000000-0000-4000-a000-000000025556;levelId=level-61422&\
transportMode=pedestrian&\
via=52.5305595965,13.3849959047;indoorMapId=indoormap-00000000-0000-4000-a000-000000025556;levelId=level-61422!passThrough=false!stopDuration=40&\
via=52.5305840995,13.38508091866;indoorMapId=indoormap-00000000-0000-4000-a000-000000025556;levelId=level-61422!stopDuration=60&\
via=52.530633782,13.38518170901;indoorMapId=indoormap-00000000-0000-4000-a000-000000025556;levelId=level-61422!passThrough=true

ルート内の中間経由地を含むサンプル出力

{
    "routes": [
        {
            "sections": [
                {
                    "type": "pedestrian",
                    "departure": {
                        "place": {
                            "type": "indoor",
                            "id": "indoormap-00000000-0000-4000-a000-000000025556",
                            "location": {
                                "lat": 52.5305136,
                                "lng": 13.3848277,
                                "lvl": 2,
                                "levelId": "level-61422"
                            }
                        }
                    },
                    "arrival": {
                        "place": {
                            "type": "indoor",
                            "id": "indoormap-00000000-0000-4000-a000-000000025556",
                            "location": {
                                "lat": 52.5305609,
                                "lng": 13.3849954,
                                "lvl": 2,
                                "levelId": "level-61422"
                            }
                        }
                    },
                    "polyline": "BXgzi-pfqtup_HE1DpLAkI7FAsJ5GA-JklBAwKzHA6ImgBAyB0FA9GiFAhF2DApDsCAuD2MA-EqSAlCyBAhI6FAkCgMA",
                    "actions": [
                        {
                            "offset": 0,
                            "action": "depart",
                            "length": 0,
                            "duration": 0
                        },
                        {
                            "offset": 0,
                            "action": "leave",
                            "length": 1.39,
                            "duration": 1.4,
                            "space": {
                                "category": "FIXTURE",
                                "type": "CUBICLE"
                            }
                        },
                        {
                            "offset": 1,
                            "action": "turn",
                            "length": 3.4,
                            "duration": 3.4,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 3,
                            "action": "turn",
                            "length": 4.39,
                            "duration": 4.4,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 4,
                            "action": "turn",
                            "length": 2.04,
                            "duration": 2,
                            "direction": "left",
                            "severity": "quite"
                        },
                        {
                            "offset": 4,
                            "action": "enter",
                            "length": 0,
                            "duration": 0,
                            "space": {
                                "category": "STRUCTURE",
                                "type": "HALLWAY"
                            }
                        },
                        {
                            "offset": 5,
                            "action": "turn",
                            "length": 4.49,
                            "duration": 4.5,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 7,
                            "action": "turn",
                            "length": 2.98,
                            "duration": 3,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 10,
                            "action": "turn",
                            "length": 3.67,
                            "duration": 3.7,
                            "direction": "left",
                            "severity": "quite"
                        },
                        {
                            "offset": 12,
                            "action": "turn",
                            "length": 1.99,
                            "duration": 2,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 14,
                            "action": "turn",
                            "length": 1.35,
                            "duration": 1.4,
                            "direction": "left",
                            "severity": "quite"
                        },
                        {
                            "offset": 14,
                            "action": "enter",
                            "length": 0,
                            "duration": 0,
                            "space": {
                                "category": "FIXTURE",
                                "type": "CUBICLE"
                            }
                        },
                        {
                            "action": "arrive",
                            "offset": 15,
                            "length": 0,
                            "duration": 0
                        }
                    ],
                    "postActions": [
                        {
                            "action": "wait",
                            "duration": 40
                        }
                    ],
                    "summary": {
                        "length": 26,
                        "duration": 66
                    },
                    "transport": {
                        "mode": "pedestrian"
                    }
                },
                {
                    "type": "pedestrian",
                    "departure": {
                        "place": {
                            "type": "indoor",
                            "id": "indoormap-00000000-0000-4000-a000-000000025556",
                            "location": {
                                "lat": 52.5305609,
                                "lng": 13.3849954,
                                "lvl": 2,
                                "levelId": "level-61422"
                            }
                        }
                    },
                    "arrival": {
                        "place": {
                            "type": "indoor",
                            "id": "indoormap-00000000-0000-4000-a000-000000025556",
                            "location": {
                                "lat": 52.5305854,
                                "lng": 13.3850824,
                                "lvl": 2,
                                "levelId": "level-61422"
                            }
                        }
                    },
                    "polyline": "BXywj-pfk2xp_HEjC_LAiI5FAmCxBAgFzDAoDpCAmHnFA-JikBAtHuFAsK2mBAtKyHA_H6FA1CzIA",
                    "actions": [
                        {
                            "offset": 0,
                            "action": "depart",
                            "length": 0,
                            "duration": 0
                        },
                        {
                            "offset": 0,
                            "action": "leave",
                            "length": 1.35,
                            "duration": 1.4,
                            "space": {
                                "category": "FIXTURE",
                                "type": "CUBICLE"
                            }
                        },
                        {
                            "offset": 1,
                            "action": "turn",
                            "length": 4.99,
                            "duration": 5,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 1,
                            "action": "enter",
                            "length": 0,
                            "duration": 0,
                            "space": {
                                "category": "STRUCTURE",
                                "type": "HALLWAY"
                            }
                        },
                        {
                            "offset": 6,
                            "action": "turn",
                            "length": 4.29,
                            "duration": 4.3,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 7,
                            "action": "turn",
                            "length": 1.45,
                            "duration": 1.5,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 8,
                            "action": "turn",
                            "length": 4.58,
                            "duration": 4.6,
                            "direction": "left",
                            "severity": "quite"
                        },
                        {
                            "offset": 9,
                            "action": "turn",
                            "length": 3.59,
                            "duration": 3.6,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 11,
                            "action": "turn",
                            "length": 1.05,
                            "duration": 1,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 11,
                            "action": "enter",
                            "length": 0,
                            "duration": 0,
                            "space": {
                                "category": "FIXTURE",
                                "type": "CUBICLE"
                            }
                        },
                        {
                            "action": "arrive",
                            "offset": 12,
                            "length": 0,
                            "duration": 0
                        }
                    ],
                    "postActions": [
                        {
                            "action": "wait",
                            "duration": 60
                        }
                    ],
                    "summary": {
                        "length": 21,
                        "duration": 81
                    },
                    "transport": {
                        "mode": "pedestrian"
                    }
                },
                {
                    "type": "pedestrian",
                    "departure": {
                        "place": {
                            "type": "indoor",
                            "id": "indoormap-00000000-0000-4000-a000-000000025556",
                            "location": {
                                "lat": 52.5305854,
                                "lng": 13.3850824,
                                "lvl": 2,
                                "levelId": "level-61422"
                            }
                        }
                    },
                    "arrival": {
                        "place": {
                            "type": "indoor",
                            "id": "indoormap-00000000-0000-4000-a000-000000025556",
                            "location": {
                                "lat": 52.5306742,
                                "lng": 13.3853206,
                                "lvl": 2,
                                "levelId": "level-61422"
                            }
                        }
                    },
                    "passthrough": [
                        {
                            "place": {
                                "type": "indoor",
                                "id": "indoormap-00000000-0000-4000-a000-000000025556",
                                "location": {
                                    "lat": 52.5306337823789,
                                    "lng": 13.385181709012262,
                                    "lvl": 2,
                                    "levelId": "level-61422"
                                }
                            },
                            "offset": 7
                        }
                    ],
                    "polyline": "BX8_j-pfwszp_HE2C0IAgI5FAuKxHAmH2aA6HzFA8FuVA3LoWA4LnWAsC3BAiBkEA8J2kBA6JqkBA8CyKAvMmZA",
                    "actions": [
                        {
                            "offset": 0,
                            "action": "depart",
                            "length": 0,
                            "duration": 0
                        },
                        {
                            "offset": 0,
                            "action": "leave",
                            "length": 1.05,
                            "duration": 1,
                            "space": {
                                "category": "FIXTURE",
                                "type": "CUBICLE"
                            }
                        },
                        {
                            "offset": 1,
                            "action": "turn",
                            "length": 3.59,
                            "duration": 3.6,
                            "direction": "left",
                            "severity": "quite"
                        },
                        {
                            "offset": 3,
                            "action": "turn",
                            "length": 3.16,
                            "duration": 3.2,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 4,
                            "action": "turn",
                            "length": 1.52,
                            "duration": 1.5,
                            "direction": "left",
                            "severity": "quite"
                        },
                        {
                            "offset": 4,
                            "action": "enter",
                            "length": 0,
                            "duration": 0,
                            "space": {
                                "category": "STRUCTURE",
                                "type": "HALLWAY"
                            }
                        },
                        {
                            "offset": 5,
                            "action": "turn",
                            "length": 2.55,
                            "duration": 2.5,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 6,
                            "action": "turn",
                            "length": 3.18,
                            "duration": 3.2,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 6,
                            "action": "enter",
                            "length": 0,
                            "duration": 0,
                            "space": {
                                "category": "FACILITY",
                                "type": "MEETING_ROOM"
                            }
                        },
                        {
                            "offset": 7,
                            "action": "uTurn",
                            "length": 3.18,
                            "duration": 3.2
                        },
                        {
                            "offset": 7,
                            "action": "leave",
                            "length": 0,
                            "duration": 0,
                            "space": {
                                "category": "FACILITY",
                                "type": "MEETING_ROOM"
                            }
                        },
                        {
                            "offset": 7,
                            "action": "enter",
                            "length": 0,
                            "duration": 0,
                            "space": {
                                "category": "STRUCTURE",
                                "type": "HALLWAY"
                            }
                        },
                        {
                            "offset": 8,
                            "action": "turn",
                            "length": 0.47,
                            "duration": 0.5,
                            "direction": "right",
                            "severity": "light"
                        },
                        {
                            "offset": 9,
                            "action": "turn",
                            "length": 10.38,
                            "duration": 10.4,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "offset": 13,
                            "action": "turn",
                            "length": 3.51,
                            "duration": 3.5,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "action": "arrive",
                            "offset": 14,
                            "length": 0,
                            "duration": 0
                        }
                    ],
                    "summary": {
                        "length": 33,
                        "duration": 33
                    },
                    "transport": {
                        "mode": "pedestrian"
                    }
                }
            ]
        }
    ]
}

出力のフィールド

  • type:歩行者や車両など、ルートのタイプを定義します
  • departure:リクエストで指定した出発地点から最も近いルート検索ノード
  • arrival:リクエストで指定した目的地点から最も近いルート検索ノード
  • passthrough:ルートを形成するもの、出発地でも目的地でもないパススルー経由地
  • polyline:複数のラインストリングを使用したルートの実際の表現。エンコードされたポリラインで、主にレンダリングに使用されます
  • actions:出発、到着、曲がる、Uターン、フロア移動などの経路案内ステップが含まれます。また、特定の空間への出入りなどのアクションを含めることもできます。各空間には、カテゴリー、タイプ、名前 (ある場合) などの情報が付属します
  • postActions:stopDurationに記載されている特定の時間 (秒単位) だけ待機するアクションが含まれます
  • summary:ポストアクションを含む、距離と所要時間に関するルートの概要
  • transport:ユーザーが指定する移動モード
📘

距離はすべてmeters(m)所要時間はすべてseconds(s)で表されます。ルート内でモードが変更されるたびに、30 secondsのトランジションペナルティが追加されます。

通知

ルートレスポンスには、ルート計算に関するエラー、警告、情報を示すさまざまな通知が含まれる場合があります。

このセクションでは、通知の主な機能を紹介します。通知の全容について詳しくは、「Indoor routing API reference」(屋内ルート検索APIリファレンス) の仕様を参照してください。

表示

通知は、レスポンスのさまざまなレベルで表示されることがあります。

最上位レベルの通知

レスポンスの最上位レベルに表示され、通常は重大な失敗を示します。たとえば、noRouteFound通知は、ルートが見つからなかったか、ユーザーが指定した条件 (ルートは車両から出発する) が満たされなかったため、ルート計算が失敗したことを示します。

ルートセクションの通知

ルート内のセクションレベルに表示され、通常は生成されたルートに問題があることを示します。ほとんどの通知は、ルート計算で回避されなかった制限を示しています (violatedAvoidStairsなど)。

属性

コード

通知codeは通知のタイプを示す列挙型 (enum) 文字列です。次のような例があります。

  • noRouteFound
  • couldNotMatchOrigin
  • couldNotMatchDestination
  • violatedRouteHeadCondition
  • ignoredVehicleEnable
  • noRouteFoundWithVia
  • couldNotMatchViaWaypoint

タイトル

このフィールドはcodeを人間が読める文字列で表すものです。次のような例があります。

  • noRouteFound - 「指定された出発地と目的地の間に利用可能なルートがありません」
  • violatedRouteHeadCondition - 「指定された車両routeHead条件でルートを提供できません」

重大度

severityは、問題の重大度を示す列挙型 (enum) 文字列です。例:

  • critical
  • info

重要な通知を含むサンプル出力

{
    "routes": [],
    "notices": [
        {
            "code": "noRouteFound",
            "title": "No route available between given origin and destination",
            "severity": "critical"
        }
    ]
}

情報通知を含むサンプル出力

{
    "routes": [
        {
            "sections": [
                {
                    "type": "vehicle",
                    "departure": {
                        "place": {
                            "type": "indoor",
                            "id": "indoormap-00000000-0000-4000-a000-000000025556",
                            "location": {
                                "lat": 52.53062766,
                                "lng": 13.38483246,
                                "lvl": -1,
                                "levelId": "level-61784"
                            }
                        }
                    },
                    "arrival": {
                        "place": {
                            "type": "indoor",
                            "id": "indoormap-00000000-0000-4000-a000-000000025556",
                            "location": {
                                "lat": 52.53064071,
                                "lng": 13.3847907,
                                "lvl": -1,
                                "levelId": "level-61784"
                            }
                        }
                    },
                    "polyline": "BXq6k-pfqwup_HBvE_QA0MjJA",
                    "actions": [
                        ...
                    ],
                    "summary": {
                        "length": 4,
                        "duration": 2
                    },
                    "transport": {
                        "mode": "car"
                    }
                },
                {
                    "type": "pedestrian",
                    "departure": {
                        "place": {
                            "type": "indoor",
                            "id": "indoormap-00000000-0000-4000-a000-000000025556",
                            "location": {
                                "lat": 52.53064071,
                                "lng": 13.3847907,
                                "lvl": -1,
                                "levelId": "level-61784"
                            }
                        }
                    },
                    "arrival": {
                        "place": {
                            "type": "indoor",
                            "id": "indoormap-00000000-0000-4000-a000-000000025556",
                            "location": {
                                "lat": 52.530651137083325,
                                "lng": 13.38482515584221,
                                "lvl": -1,
                                "levelId": "level-61784"
                            }
                        }
                    },
                    "polyline": "BXuil-pfm2tp_HBiG8VAOJA",
                    "actions": [
                        ...
                    ],
                    "summary": {
                        "length": 3,
                        "duration": 33
                    },
                    "transport": {
                        "mode": "pedestrian"
                    }
                }
            ]
        }
    ],
    "notices": [
        {
            "code": "violatedEntireRouteCondition",
            "title": "Cannot provide route with the given vehicle entrieRoute condition.",
            "severity": "info"
        }
    ]
}