{"openapi":"3.0.2","info":{"title":"RoutePlanner Routing API","description":"A location service providing customizable route calculations for a variety of vehicle types as well as pedestrian modes.","termsOfService":"https://companyinfo.nl/","license":{"name":"Company.info B.V.","url":"https://companyinfo.nl/"},"version":"2","x-document-meta-data":{"copyright":"© 2021 Company.info B.V."}},"servers":[{"url":"https://api.company.info/routeplanner/routing","description":"Production server for the RoutePlanner Routing Service"}],"security":[{"ApiKeyAuth":[]}],"x-readme":{"proxy-enabled":false},"paths":{"/routes":{"get":{"operationId":"getRoutes","tags":["Routing"],"summary":"Calculate routes","description":"Calculates a route using a generic vehicle/pedestrian mode, e.g. car, truck, pedestrian, etc...","parameters":[{"name":"transportMode","in":"query","description":"Mode of transport to be used for the calculation of the route.\n\nNote:\n`taxi` and `bus` modes are in Alpha state. They are not yet stable and behaviour may change drastically, or even become unsupported, without warning.\n`taxi` and `bus` modes take into account taxi/bus restricted streets as well as streets reserved for exclusive taxi/bus access. It does not, however,\nconsider exclusive lanes in otherwise shared streets. Also, the streets that are for exclusive access for taxi/bus are used only if either the origin\nor destination are on them.\n","required":true,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/RouterMode"}},{"name":"origin","in":"query","description":"A location defining origin of the trip.\n\n## Format\n\nFormat: `Place[WaypointOptions]`\n\n* Place: `{lat},{lng}[PlaceOptions]`\n* PlaceOptions: `;option1=value1;option2=value2...`\n* WaypointOptions: `!option1=value1!option2=value2...`\n\nA waypoint consists of:\n\n* Exactly one place\n* Optional settings for the place\n* Optional settings for the waypoint itself\n\nSupported place options:\n\n* `course`: int, degrees clock-wise from north. Indicating desired direction at the place.\n  E.g. `90` indicating `east`. Often combined with `radius` and/or `minCourseDistance`\n* `sideOfStreetHint`: `{lat},{lng}`. Indicating the side of the street that should be\n  used. E.g. if the location is to the left of the street, the router will prefer using\n  that side in case the street has dividers. E.g.\n  `52.511496,13.304140;sideOfStreetHint=52.512149,13.304076` indicates that the `north`\n  side of the street should be preferred. This option is required, if `matchSideOfStreet`\n  is set to `always`.\n* `matchSideOfStreet`: enum `[always, onlyIfDivided]`. Specifies how the location set by\n  `sideOfStreetHint` should be handled. Requires `sideOfStreetHint` to be specified as\n  well.\n  + `always` : Always prefer the given side of street.\n  + `onlyIfDivided`: Only prefer using side of street set by `sideOfStreetHint` in case\n    the street has dividers. This is the default behavior.\n* `nameHint`: string. Causes the router to look for the place with the most similar name.\n  This can e.g. include things like: `North` being used to differentiate between\n  interstates `I66 North` and `I66 South`, `Downtown Avenue` being used to correctly\n  select a residental street.\n* `radius`: int, meters. Asks the router to consider all places within the given radius as\n  potential candidates for route calculation. This can be either because it is not\n  important which place is used, or because it is unknown. Radius more than 200meter are\n  not supported.\n* `minCourseDistance`: int, meters. Asks the routing service to try find a route that avoids actions for\n  the indicated distance. E.g. if the origin is determined by a moving vehicle, the user\n  might not have time to react to early actions.\n\nNotes:\n\n* `stopDuration` option is not supported for `origin`, contrary to `destination` and\n  `via` waypoints.\n* `passThrough`: option is not supported for 'origin'.\n* Non-structural reserved characters in options' values need to be properly percent-encoded.\n  Please refer to the developers' guide for more details.\n","required":true,"style":"form","explode":true,"allowReserved":true,"schema":{"$ref":"#/components/schemas/Waypoint"},"examples":{"coordinate":{"summary":"A simple WGS84 coordinate","value":"51.611571,11.351608"},"side":{"summary":"Populating sideOfStreetHint in addition to location to avoid ending on the wrong side of the street","value":"52.531052,13.384872;sideOfStreetHint=52.530941,13.384939;matchSideOfStreet=always"},"course":{"summary":"Setting course/radius/minCourseDistance an uncertain GPS coordinate of a moving vehicle","value":"51.611571,11.351608;course=170;radius=20;minCourseDistance=500"},"name":{"summary":"Setting nameHint to avoid matching to the wrong location","value":"52.510319,13.285616;nameHint=Kaiserdamm"},"duration":{"summary":"Addition a stopDuration for an intermediate stop","value":"51.611571,11.351608!stopDuration=600"}}},{"name":"destination","in":"query","description":"A location defining destination of the trip.\n\n## Format\n\nFormat: `Place[WaypointOptions]`\n\n* Place: `{lat},{lng}[PlaceOptions]`\n* PlaceOptions: `;option1=value1;option2=value2...`\n* WaypointOptions: `!option1=value1!option2=value2...`\n\nA waypoint consists of:\n\n* Exactly one place\n* Optional settings for the place\n* Optional settings for the waypoint itself\n\nSupported place options:\n\n* `course`: int, degrees clock-wise from north. Indicating desired direction at the place.\n  E.g. `90` indicating `east`. Often combined with `radius` and/or `minCourseDistance`\n* `sideOfStreetHint`: `{lat},{lng}`. Indicating the side of the street that should be\n  used. E.g. if the location is to the left of the street, the router will prefer using\n  that side in case the street has dividers. E.g.\n  `52.511496,13.304140;sideOfStreetHint=52.512149,13.304076` indicates that the `north`\n  side of the street should be preferred. This option is required, if `matchSideOfStreet`\n  is set to `always`.\n* `matchSideOfStreet`: enum `[always, onlyIfDivided]`. Specifies how the location set by\n  `sideOfStreetHint` should be handled. Requires `sideOfStreetHint` to be specified as\n  well.\n  + `always` : Always prefer the given side of street.\n  + `onlyIfDivided`: Only prefer using side of street set by `sideOfStreetHint` in case\n    the street has dividers. This is the default behavior.\n* `nameHint`: string. Causes the router to look for the place with the most similar name.\n  This can e.g. include things like: `North` being used to differentiate between\n  interstates `I66 North` and `I66 South`, `Downtown Avenue` being used to correctly\n  select a residental street.\n* `radius`: int, meters. Asks the router to consider all places within the given radius as\n  potential candidates for route calculation. This can be either because it is not\n  important which place is used, or because it is unknown. Radius more than 200meter are\n  not supported.\n* `minCourseDistance`: int, meters. Asks the routing service to try find a route that avoids actions for\n  the indicated distance. E.g. if the origin is determined by a moving vehicle, the user\n  might not have time to react to early actions.\n\nSupported waypoint options:\n\n* `stopDuration`: desired duration for the stop, in seconds. The section arriving at this\n  via waypoint will have a `wait` post action reflecting the stopping time. The\n  consecutive section will start at the arrival time of the former section + stop\n  duration.\n* `passThrough`: option is not supported for 'destination'.\n\nNotes:\n\n* Non-structural reserved characters in options' values need to be properly percent-encoded.\n  Please refer to the developers' guide for more details.\n","required":true,"style":"form","explode":true,"allowReserved":true,"schema":{"$ref":"#/components/schemas/Waypoint"},"examples":{"coordinate":{"summary":"A simple WGS84 coordinate","value":"51.611571,11.351608"},"side":{"summary":"Populating sideOfStreetHint in addition to location to avoid ending on the wrong side of the street","value":"52.531052,13.384872;sideOfStreetHint=52.530941,13.384939;matchSideOfStreet=always"},"course":{"summary":"Setting course/radius/minCourseDistance an uncertain GPS coordinate of a moving vehicle","value":"51.611571,11.351608;course=170;radius=20;minCourseDistance=500"},"name":{"summary":"Setting nameHint to avoid matching to the wrong location","value":"52.510319,13.285616;nameHint=Kaiserdamm"},"duration":{"summary":"Addition a stopDuration for an intermediate stop","value":"51.611571,11.351608!stopDuration=600"}}},{"name":"via","in":"query","description":"A location defining a via waypoint.\n\nA via waypoint is a location between origin and destination. The route will do a stop\nat the via waypoint.\n\nMultiple waypoints can also be specified using multiple via parameters like\n`via=...&via=...`, in which case the route will traverse these waypoints sequentially in\nthe order specified in the request.\n\n## Format\n\nFormat: `Place[WaypointOptions]`\n\n* Place: `{lat},{lng}[PlaceOptions]`\n* PlaceOptions: `;option1=value1;option2=value2...`\n* WaypointOptions: `!option1=value1!option2=value2...`\n\nA waypoint consists of:\n\n* Exactly one place\n* Optional settings for the place\n* Optional settings for the waypoint itself\n\nSupported place options:\n\n* `course`: int, degrees clock-wise from north. Indicating desired direction at the place.\n  E.g. `90` indicating `east`. Often combined with `radius` and/or `minCourseDistance`\n* `sideOfStreetHint`: `{lat},{lng}`. Indicating the side of the street that should be\n  used. E.g. if the location is to the left of the street, the router will prefer using\n  that side in case the street has dividers. E.g.\n  `52.511496,13.304140;sideOfStreetHint=52.512149,13.304076` indicates that the `north`\n  side of the street should be preferred. This option is required, if `matchSideOfStreet`\n  is set to `always`.\n* `matchSideOfStreet`: enum `[always, onlyIfDivided]`. Specifies how the location set by\n  `sideOfStreetHint` should be handled. Requires `sideOfStreetHint` to be specified as\n  well.\n  + `always` : Always prefer the given side of street.\n  + `onlyIfDivided`: Only prefer using side of street set by `sideOfStreetHint` in case\n    the street has dividers. This is the default behavior.\n* `nameHint`: string. Causes the router to look for the place with the most similar name.\n  This can e.g. include things like: `North` being used to differentiate between\n  interstates `I66 North` and `I66 South`, `Downtown Avenue` being used to correctly\n  select a residental street.\n* `radius`: int, meters. Asks the router to consider all places within the given radius as\n  potential candidates for route calculation. This can be either because it is not\n  important which place is used, or because it is unknown. Radius more than 200meter are\n  not supported.\n* `minCourseDistance`: int, meters. Asks the routing service to try find a route that avoids actions for\n  the indicated distance. E.g. if the origin is determined by a moving vehicle, the user\n  might not have time to react to early actions.\n\nSupported waypoint options:\n* `stopDuration`: desired duration for the stop, in seconds.\n* `passThrough`: boolean. Asks the router to avoid the following during route calculation:\n  + Introducing a stop at the waypoint.\n  + Splitting the route into sections.\n  + Changing the direction of travel.\n\n  Following scenarios are not supported for `passThrough` parameter:\n  + Setting both `stopDuration` to a value greater than 0 and `passThrough=true`.\n  + Setting `passThrough=true` for `origin` or `destination` of a route.\n  The default value is `false`.\n\nNotes:\n\n* Non-structural reserved characters in options' values need to be properly percent-encoded.\n  Please refer to the developers' guide for more details.\n","required":false,"style":"form","explode":true,"allowReserved":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/Waypoint"}},"examples":{"coordinate":{"summary":"A simple WGS84 coordinate","value":"51.611571,11.351608"},"side":{"summary":"Populating sideOfStreetHint in addition to location to avoid ending on the wrong side of the street","value":"52.531052,13.384872;sideOfStreetHint=52.530941,13.384939;matchSideOfStreet=always"},"course":{"summary":"Setting course/radius/minCourseDistance an uncertain GPS coordinate of a moving vehicle","value":"51.611571,11.351608;course=170;radius=20;minCourseDistance=500"},"name":{"summary":"Setting nameHint to avoid matching to the wrong location","value":"52.510319,13.285616;nameHint=Kaiserdamm"},"duration":{"summary":"Addition a stopDuration for an intermediate stop","value":"51.611571,11.351608!stopDuration=600"},"pass-through":{"summary":"Setting pass-through parameter to avoid possibly making a u-turn for a stop","value":"51.611571,11.351608!passThrough=true"}}},{"name":"departureTime","in":"query","description":"Specifies the time of departure as defined by either `date-time` or `full-date` `T`\n`partial-time` in `RFC 3339`, section 5.6 (for example, `2019-06-24T01:23:45`).\n\nThe requested time is converted to local time at origin. When the optional timezone offset\nis not specified, time is assumed to be local. The special value `any` can be used to\nindicate that time should not be taken into account during routing. If neither\n`departureTime` or `arrivalTime` are specified, current time at departure place will be\nused. All time values in the response are returned in the timezone of each location.\n","required":false,"style":"form","explode":true,"allowReserved":true,"schema":{"$ref":"#/components/schemas/TimeWithAny"}},{"name":"routingMode","in":"query","description":"Specifies which optimization is applied during route calculation.\n\n* `fast`: Route calculation from start to destination optimized by travel time. In many\n  cases, the route returned by the `fast` mode may not be the route with the fastest\n  possible travel time. For example, the routing service may favor a route that remains on\n  a highway, even if a faster travel time can be achieved by taking a detour or shortcut\n  through an inconvenient side road.\n* `short`: Route calculation from start to destination disregarding any speed information.\n  In this mode, the distance of the route is minimized, while keeping the route sensible.\n  This includes, for example, penalizing turns. Because of that, the resulting route will\n  not necessarily be the one with minimal distance.\n\nNotes:\n* The following Transport modes only support `fast` routingMode\n  - `bicycle`\n  - `bus`\n  - `pedestrian`\n  - `scooter`\n  - `taxi`\n","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/RoutingMode"}},{"name":"alternatives","in":"query","description":"Number of alternative routes to return aside from the optimal route.","required":false,"style":"form","explode":true,"schema":{"maximum":6,"minimum":0,"type":"integer","default":0}},{"name":"avoid","in":"query","description":"Avoid routes that violate certain features of road network or that go through\nuser-specified geographical bounding boxes.\n\nNote that if the origin, destination, or any via is in an avoided area or on an avoided\nfeature, a route is produced that violates the avoid restriction. In such a case, the\nroute is trying to minimize the violation of the avoid restrictions and can therefore\ninclude large deviations from a route that is calculated without these avoid\nrestrictions.\n\nIt is also possible that the produced route violates the avoid restriction in between\nwaypoints, if no other route is possible or too hard to find. One such example is\nrequesting a route to an island that is only reachable with ferries while specifying\n`avoid[features]=ferry`.\n\nFurther, avoid can cause the route calculation to fail, if no route is possible or too\nhard to find.\n\nSpecify properties using array notation like `avoid[features]=controlledAccessHighway,tunnel`.\n","required":false,"style":"deepObject","explode":false,"allowReserved":true,"schema":{"$ref":"#/components/schemas/Avoid"},"examples":{"features":{"summary":"Avoid specific features like `tunnel' or `ferry`","value":"avoid[features]=tunnel,ferry"},"area":{"summary":"Avoid a specific geographical bounding box","value":"avoid[areas]=bbox:13.082,52.416,13.628,52.626"},"areas":{"summary":"Avoid multiple geographical bounding boxes using `|` as element separator","value":"avoid[areas]=bbox:13.3127778,52.5106221,13.3495852,52.5255681|bbox:13.3958343,52.5171209,13.4286456,52.5405511"},"complete":{"summary":"Avoid both features and geographical bounding boxes","value":"avoid[features]=tollRoad,tunnel&avoid[areas]=bbox:13.082,52.416,13.628,52.626"},"zones":{"summary":"Avoid multiple environmental zones using identifiers"},"zoneCategory":{"summary":"Avoid all environmental zones","value":"avoid[zoneCategories]=environmental"},"zoneCategoryWithException":{"summary":"Avoid all environmental zones except a specific one"}}},{"name":"exclude","in":"query","description":"Defines properties which will be strictly excluded from route calculation.\n","required":false,"style":"deepObject","explode":false,"schema":{"$ref":"#/components/schemas/Exclude"}},{"name":"units","in":"query","description":"Units of measurement used in guidance instructions. The default is `metric`.\n","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/Units"}},{"name":"lang","in":"query","description":"Specifies the preferred language of the response. The value should comply with the [IETF BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"en-US"}},{"name":"return","in":"query","description":"Defines which attributes are included in the response as part of data representation of a\n`Route` or `Section`.\n\n* `polyline` - Polyline for the route in Flexible Polyline Encoding.\n  Either a 2D polyline (without `elevation` specified), or a 3D polyline with the 3rd dimension type `Elevation` (with `elevation` specified).\n* `actions` - Actions (such as maneuvers or tasks) that must be taken to complete the section.\n* `instructions` - Include instructions in returned actions. Instructions are localized to the requested language.\n* `summary` - Include summary for the section.\n* `travelSummary` - Include summary for the travel portion of the section.\n* `turnByTurnActions` - Include all information necessary to support turn by turn guidance to complete the section.\n* `mlDuration` - Use a region-specific machine learning model to calculate route duration. **Disclaimer: This parameter is currently in beta release, and is therefore subject to breaking changes.**\n* `elevation` - Include elevation information in coordinate and geometry types. See e.g. `polyline` or `location`.\n* `routeHandle` - Encode calculated route and return a handle which can be used with\n  `routes/{routeHandle}` to decode the route at a later point in time.\n* `passthrough` - Include information on passthrough via waypoints in the section.\n* `incidents` - Include a list of all incidents applicable to each section.\n                Incidents are localized to the requested language.\n                This requires `incidents` to be specified as part of the `return` parameter.\n* `routingZones` - Include information about routing zones each section goes through.\n\nFollowing restrictions apply when specifying return parameter:\n\n* If `actions` is requested, then `polyline` must also be requested as well.\n* If `instructions` is requested, then `actions` must also be requested as well.\n* If `turnByTurnActions` is requested, then `polyline` must also be requested as well.\n* If at least one attribute is requested within the `spans` parameter, then `polyline` must be request as well\n","required":false,"style":"form","explode":false,"schema":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/Return"}}},{"name":"spans","in":"query","description":"Defines which attributes are included in the response spans. For example, `attributes,length`\nwill enable the fields `attributes` and `length` in the route response.\n\nThis parameter also requires that the `polyline` option is set within the `return` parameter.\n","required":false,"style":"form","explode":false,"schema":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/Spans"}}},{"name":"truck","in":"query","description":"Truck specific parameters.\n  * `shippedHazardousGoods`:\n    Comma-separated list of shipped hazardous goods in the vehicle.\n    Possible values are:\n    * `explosive`: Explosive material\n    * `gas`: Gas\n    * `flammable`: Flammable material\n    * `combustible`: Combustible material\n    * `organic`: Organic material\n    * `poison`: Poison\n    * `radioactive`: Radioactive material\n    * `corrosive`: Corrosive material\n    * `poisonousInhalation`: Materials that are poisonous upon inhalation\n    * `harmfulToWater`: Materials that are harmful to water\n    * `other`: Other types of hazardous materials\n  * `grossWeight`: Vehicle weight including trailers and shipped goods, in kilograms.\n  * `weightPerAxle`: Vehicle weight per axle, in kilograms.\n  * `height`: Vehicle height, in centimeters.\n  * `width`: Vehicle width, in centimeters.\n  * `length`: Vehicle length, in centimeters.\n  * `tunnelCategory`: Specifies the tunnel category used to restrict transport of specific goods.\n    Possible values:\n      * `B`\n      * `C`\n      * `D`\n      * `E`\n  * `axleCount`: Defines total number of axles in the vehicle.\n  * `type`: Specifies the type of truck\n      * `straight`: a truck on a single frame with a permanently attached cargo area\n      * `tractor`: a towing vehicle that can pull one or more semi-trailers (aka semi-truck)\n  * `trailerCount`: Number of trailers attached to the vehicle.\n","required":false,"style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/Truck"}},{"name":"ev","in":"query","required":false,"style":"deepObject","explode":false,"allowReserved":true,"schema":{"$ref":"#/components/schemas/EV"}},{"name":"vehicle","in":"query","required":false,"style":"deepObject","explode":false,"schema":{"$ref":"#/components/schemas/Vehicle"}},{"name":"pedestrian[speed]","in":"query","description":"**Disclaimer: This parameter is currently in beta release, and is therefore subject to breaking changes.\nThe parameter could be extracted to a separate API if speed capping for cars/trucks is introduced**\nWalking speed in meters per second. Influences the duration of walking segments along the route.\n","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/PedestrianSpeed"}},{"name":"X-Request-ID","in":"header","description":"User-provided token that can be used to trace a request or a group of requests sent to the service.","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"scooter","in":"query","description":"Scooter specific parameters.\n  * `allowHighway`: Specifies whether scooter is allowed on highway or not. This parameter is optional.\n    If not provided, then by default scooter is not allowed to use highway.\n    There is a similar parameter avoid[features]=controlledAccessHighway to disallow highway usage.\n    avoid[features] takes precedence so if this parameter is also used then scooters are not allowed\n    to use highways even if `allowHighway` is used with value as true.\n    Possible values:\n      * `true`: scooter is allowed to use highway.\n      * `false`: scooter is not allowed to use highway.\n","required":false,"style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/Scooter"}},{"name":"traffic","in":"query","description":"Traffic specific parameters.","required":false,"style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/Traffic"}}],"responses":{"200":{"description":"Routes API response in case of success","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RouterRouteResponse"},"examples":{"routeResponseExample":{"$ref":"#/components/examples/routeResponseExample"}}}}},"400":{"description":"Failure to parse the request, caused by, for example, invalid parameter values such as\n`transportMode=spaceShuttle` or `alternatives=999`.\n\nNote that route calculation errors aren't considered failures. Cf. `RouterRouteResponse`\nfor details on route calculation errors.\n","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoutingErrorResponse"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/400RoutingErrorResponseExample"}}}}},"401":{"description":"API response in case of unauthorized access.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthErrorResponseSchema"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/401errorResponseExample"}}}}},"403":{"description":"Not allowed, such as trying to calculate routes in Japan without having necessary\npermissions.\n","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_403"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/403RoutingErrorResponseExample"}}}}},"500":{"description":"Internal server error","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoutingErrorResponse"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/500RoutingErrorResponseExample"}}}}}}}},"/routes/{routeHandle}":{"get":{"operationId":"getRoutesByHandle","tags":["Routing"],"summary":"Get route by handle","description":"Decodes and returns a route from a previously calculated route handle.\n\n**Alpha**: This API is not yet stable and is subject to change.\n\nA route handle encodes a previously calculated route. A route can be decoded from a handle\nas long the service uses the same map data which was used during encoding.\n\nAll parameters of the `/routes` endpoint are supported, except for `origin`, `destination`,\n`via`, `alternatives` and `routingMode`. See also the `return` parameter of `/routes`\nendpoint.\n\nThe `transportMode` parameter does not have to match the transport mode previously used for\nroute calculation. However, when using a different transport mode, the request may fail,\ne.g. when the route has road segments forbidden for the provided transport mode.\n","parameters":[{"name":"routeHandle","in":"path","description":"Route handle returned from a previous route calculation.\n\nSee `return` parameter of `/routes` endpoint for more information.\n","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"transportMode","in":"query","description":"Mode of transport to be used for the calculation of the route.\n\nNote:\n`taxi` and `bus` modes are in Alpha state. They are not yet stable and behaviour may change drastically, or even become unsupported, without warning.\n`taxi` and `bus` modes take into account taxi/bus restricted streets as well as streets reserved for exclusive taxi/bus access. It does not, however,\nconsider exclusive lanes in otherwise shared streets. Also, the streets that are for exclusive access for taxi/bus are used only if either the origin\nor destination are on them.\n","required":true,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/RouterMode"}},{"name":"departureTime","in":"query","description":"Specifies the time of departure as defined by either `date-time` or `full-date` `T`\n`partial-time` in `RFC 3339`, section 5.6 (for example, `2019-06-24T01:23:45`).\n\nThe requested time is converted to local time at origin. When the optional timezone offset\nis not specified, time is assumed to be local. The special value `any` can be used to\nindicate that time should not be taken into account during routing. If neither\n`departureTime` or `arrivalTime` are specified, current time at departure place will be\nused. All time values in the response are returned in the timezone of each location.\n","required":false,"style":"form","explode":true,"allowReserved":true,"schema":{"$ref":"#/components/schemas/TimeWithAny"}},{"name":"avoid","in":"query","description":"Avoid routes that violate certain features of road network or that go through\nuser-specified geographical bounding boxes.\n\nNote that if the origin, destination, or any via is in an avoided area or on an avoided\nfeature, a route is produced that violates the avoid restriction. In such a case, the\nroute is trying to minimize the violation of the avoid restrictions and can therefore\ninclude large deviations from a route that is calculated without these avoid\nrestrictions.\n\nIt is also possible that the produced route violates the avoid restriction in between\nwaypoints, if no other route is possible or too hard to find. One such example is\nrequesting a route to an island that is only reachable with ferries while specifying\n`avoid[features]=ferry`.\n\nFurther, avoid can cause the route calculation to fail, if no route is possible or too\nhard to find.\n\nSpecify properties using array notation like `avoid[features]=controlledAccessHighway,tunnel`.\n","required":false,"style":"deepObject","explode":false,"allowReserved":true,"schema":{"$ref":"#/components/schemas/Avoid"},"examples":{"features":{"summary":"Avoid specific features like `tunnel' or `ferry`","value":"avoid[features]=tunnel,ferry"},"area":{"summary":"Avoid a specific geographical bounding box","value":"avoid[areas]=bbox:13.082,52.416,13.628,52.626"},"areas":{"summary":"Avoid multiple geographical bounding boxes using `|` as element separator","value":"avoid[areas]=bbox:13.3127778,52.5106221,13.3495852,52.5255681|bbox:13.3958343,52.5171209,13.4286456,52.5405511"},"complete":{"summary":"Avoid both features and geographical bounding boxes","value":"avoid[features]=tollRoad,tunnel&avoid[areas]=bbox:13.082,52.416,13.628,52.626"},"zones":{"summary":"Avoid multiple environmental zones using identifiers"},"zoneCategory":{"summary":"Avoid all environmental zones","value":"avoid[zoneCategories]=environmental"},"zoneCategoryWithException":{"summary":"Avoid all environmental zones except a specific one"}}},{"name":"exclude","in":"query","description":"Defines properties which will be strictly excluded from route calculation.\n","required":false,"style":"deepObject","explode":false,"schema":{"$ref":"#/components/schemas/Exclude"}},{"name":"units","in":"query","description":"Units of measurement used in guidance instructions. The default is `metric`.\n","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/Units"}},{"name":"lang","in":"query","description":"Specifies the preferred language of the response. The value should comply with the [IETF BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"en-US"}},{"name":"return","in":"query","description":"Defines which attributes are included in the response as part of data representation of a\n`Route` or `Section`.\n\n* `polyline` - Polyline for the route in Flexible Polyline Encoding.\n  Either a 2D polyline (without `elevation` specified), or a 3D polyline with the 3rd dimension type `Elevation` (with `elevation` specified).\n* `actions` - Actions (such as maneuvers or tasks) that must be taken to complete the section.\n* `instructions` - Include instructions in returned actions. Instructions are localized to the requested language.\n* `summary` - Include summary for the section.\n* `travelSummary` - Include summary for the travel portion of the section.\n* `turnByTurnActions` - Include all information necessary to support turn by turn guidance to complete the section.\n* `mlDuration` - Use a region-specific machine learning model to calculate route duration. **Disclaimer: This parameter is currently in beta release, and is therefore subject to breaking changes.**\n* `elevation` - Include elevation information in coordinate and geometry types. See e.g. `polyline` or `location`.\n* `routeHandle` - Encode calculated route and return a handle which can be used with\n  `routes/{routeHandle}` to decode the route at a later point in time.\n* `passthrough` - Include information on passthrough via waypoints in the section.\n* `incidents` - Include a list of all incidents applicable to each section.\n                Incidents are localized to the requested language.\n                This requires `incidents` to be specified as part of the `return` parameter.\n* `routingZones` - Include information about routing zones each section goes through.\n\nFollowing restrictions apply when specifying return parameter:\n\n* If `actions` is requested, then `polyline` must also be requested as well.\n* If `instructions` is requested, then `actions` must also be requested as well.\n* If `turnByTurnActions` is requested, then `polyline` must also be requested as well.\n* If at least one attribute is requested within the `spans` parameter, then `polyline` must be request as well\n","required":false,"style":"form","explode":false,"schema":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/Return"}}},{"name":"spans","in":"query","description":"Defines which attributes are included in the response spans. For example, `attributes,length`\nwill enable the fields `attributes` and `length` in the route response.\n\nThis parameter also requires that the `polyline` option is set within the `return` parameter.\n","required":false,"style":"form","explode":false,"schema":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/Spans"}}},{"name":"truck","in":"query","description":"Truck specific parameters.\n  * `shippedHazardousGoods`:\n    Comma-separated list of shipped hazardous goods in the vehicle.\n    Possible values are:\n    * `explosive`: Explosive material\n    * `gas`: Gas\n    * `flammable`: Flammable material\n    * `combustible`: Combustible material\n    * `organic`: Organic material\n    * `poison`: Poison\n    * `radioactive`: Radioactive material\n    * `corrosive`: Corrosive material\n    * `poisonousInhalation`: Materials that are poisonous upon inhalation\n    * `harmfulToWater`: Materials that are harmful to water\n    * `other`: Other types of hazardous materials\n  * `grossWeight`: Vehicle weight including trailers and shipped goods, in kilograms.\n  * `weightPerAxle`: Vehicle weight per axle, in kilograms.\n  * `height`: Vehicle height, in centimeters.\n  * `width`: Vehicle width, in centimeters.\n  * `length`: Vehicle length, in centimeters.\n  * `tunnelCategory`: Specifies the tunnel category used to restrict transport of specific goods.\n    Possible values:\n      * `B`\n      * `C`\n      * `D`\n      * `E`\n  * `axleCount`: Defines total number of axles in the vehicle.\n  * `type`: Specifies the type of truck\n      * `straight`: a truck on a single frame with a permanently attached cargo area\n      * `tractor`: a towing vehicle that can pull one or more semi-trailers (aka semi-truck)\n  * `trailerCount`: Number of trailers attached to the vehicle.\n","required":false,"style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/Truck"}},{"name":"ev","in":"query","required":false,"style":"deepObject","explode":false,"allowReserved":true,"schema":{"$ref":"#/components/schemas/EV"}},{"name":"vehicle","in":"query","required":false,"style":"deepObject","explode":false,"schema":{"$ref":"#/components/schemas/Vehicle"}},{"name":"X-Request-ID","in":"header","description":"User-provided token that can be used to trace a request or a group of requests sent to the service.","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"scooter","in":"query","description":"Scooter specific parameters.\n  * `allowHighway`: Specifies whether scooter is allowed on highway or not. This parameter is optional.\n    If not provided, then by default scooter is not allowed to use highway.\n    There is a similar parameter avoid[features]=controlledAccessHighway to disallow highway usage.\n    avoid[features] takes precedence so if this parameter is also used then scooters are not allowed\n    to use highways even if `allowHighway` is used with value as true.\n    Possible values:\n      * `true`: scooter is allowed to use highway.\n      * `false`: scooter is not allowed to use highway.\n","required":false,"style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/Scooter"}},{"name":"traffic","in":"query","description":"Traffic specific parameters.","required":false,"style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/Traffic"}}],"responses":{"200":{"description":"Routes API response in case of success","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RouterRouteResponse"},"examples":{"routeResponseExample":{"$ref":"#/components/examples/routeResponseExample"}}}}},"400":{"description":"Failure to parse the request, caused by, for example, invalid parameter values such as\n`transportMode=spaceShuttle` or `alternatives=999`.\n\nNote that route calculation errors aren't considered failures. Cf. `RouterRouteResponse`\nfor details on route calculation errors.\n","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoutingErrorResponse"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/400RoutingErrorResponseExample"}}}}},"401":{"description":"API response in case of unauthorized access.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthErrorResponseSchema"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/401errorResponseExample"}}}}},"403":{"description":"Not allowed, such as trying to calculate routes in Japan without having necessary\npermissions.\n","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_403"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/403RoutingErrorResponseExample"}}}}},"500":{"description":"Internal server error","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoutingErrorResponse"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/500RoutingErrorResponseExample"}}}}}}}}},"components":{"schemas":{"AccessAttributes":{"type":"string","description":"Extensible enum: `open` `noThrough` `tollRoad` `...`\n`AccessAttributes` is applied to a span of a route section and describes access flags of a street.\n\n* `open`: Describes whether this part of the route can be traversed.\n* `noThrough`: A part of the route you can only enter if your destination is located there.\n* `tollRoad`: Access to this part of the route is restricted with a fee (or toll).\n\nAs it is possible that new access attributes are supported in the future, unknown access attributes should be ignored.\n","x-extensible-enum":["open","noThrough","tollRoad"]},"AttributionLinkType":{"required":["type"],"type":"string","description":"Attribution link type.\n\n* `disclaimer` - Page with further legal information from the agency.\n* `tariff` - Page with information on the tariff.\n","enum":["disclaimer","tariff"]},"AuthErrorResponseSchema":{"properties":{"error":{"type":"string","description":"Human-readable error"},"error_description":{"type":"string","description":"Human-readable error description"}}},"Avoid":{"type":"object","properties":{"features":{"type":"string","description":"A comma separated list of features that routes will avoid.\n\n* `seasonalClosure`\n* `tollRoad`\n* `controlledAccessHighway`\n* `ferry`\n* `carShuttleTrain`\n* `tunnel`\n* `dirtRoad`\n* `difficultTurns`\n"},"areas":{"type":"string","description":"A pipe separated list of user defined areas that routes will avoid to go through.\n\nFormat: `{shape1}|{shape2}|{shape3}...`\n\nSupported shape format:\n* Bounding box - A rectangular area on earth defined by a comma separated list of two latitude and two longitude values.\n  - Format: `bbox:{west},{south},{east},{north}`\n    + `{west}`  - Longitude value of the westernmost point of the area.\n    + `{south}` - Latitude value of the southernmost point of the area.\n    + `{east}`  - Longitude value of the easternmost point of the area.\n    + `{north}` - Latitude value of the northernmost point of the area.\n  - Example: `bbox:13.082,52.416,13.628,52.626` - Bounding box of Berlin\n"},"zoneCategories":{"type":"string","description":"Specifies a list of categories of zones which routes will avoid going through.\n\nFormat: `Categories[ZoneCategoryOptions]`\n\n* Categories: `{cat1},{cat2}...`\n  A comma separated list of zone categories.\n* ZoneCategoriesOptions (optional): `;option1=value1;options2=value2...`\n  A list of options for zone categories in `KEY=VALUE` form.\n\nSupported zone category options:\n  * exceptZoneIds: A comma-separated list of zone identifiers, which will not be taken into account for evaluation of zone categories to avoid.\n\nSupported zone categories:\n  * `vignette`\n  * `congestionPricing`\n  * `environmental`\n\nExample of zone categories avoidance:\n`avoid[zoneCategories]=environmental,vignette`\n"},"zoneIdentifiers":{"type":"string","description":"A comma separated list containing identifiers of zones that routes will avoid going through.\n"}}},"BaseNoticeDetail":{"required":["type"],"properties":{"title":{"type":"string","description":"Detail title"},"cause":{"type":"string","description":"Cause of the notice"},"type":{"type":"string","description":"Detail type. Each type of detail might contain extra attributes.\n\n**NOTE:** The list of possible detail types may be extended in the future.\nThe client application is expected to handle such a case gracefully.\n"}}},"ChargingConnectorType":{"type":"string","description":"Extensible enum: `iec62196Type1Combo` `iec62196Type2Combo` `chademo` `tesla` `...`\nCurrently supported connector types are:\n* `iec62196Type1Combo`:  Type 1 Combo connector, commonly called \"SAE J1772\"\n* `iec62196Type2Combo`:  Type 2 Combo connector, commonly called \"Mennekes\"\n* `chademo`: CHAdeMO connector\n* `tesla`: Tesla connector\n","x-extensible-enum":["iec62196Type1Combo","iec62196Type2Combo","chademo","tesla"]},"ChargingSupplyType":{"type":"string","description":"Extensible enum: `acSingle` `acThree` `dc` `...`\nCurrently possible values are:\n\n* `acSingle` : Single phase Alternating Current supply\n* `acThree`: Three phase Alternating Current supply\n* `dc`: Direct Current supply\n","x-extensible-enum":["acSingle","acThree","dc"]},"Color":{"pattern":"#[0-9A-Fa-f]{6}","type":"string","example":"#FF0000"},"ConsumptionSpeedTable":{"type":"string","description":"Function curve specifying consumption rate at a given speed.\n\nThe format of the string is a comma-separated list of numbers, as follows:\n\n```\n<SPEED_0>,<CONSUMPTION_0>,<SPEED_1>,<CONSUMPTION_1>,...,<SPEED_N>,<CONSUMPTION_N>\n```\n\nwhere speed values are strictly increasing, non-negative integers in units of (km/h), and\nconsumption values are non-negative floating point values in units of (Wh/m).\n\nThe function is linearly interpolated between data points. For speeds less than `SPEED_0`\nthe value of the function is `CONSUMPTION_0`, and for speeds greater than `SPEED_N` the\nvalue of the function is `CONSUMPTION_N`.\n","example":"0,0.2394,14,0.2394,36,0.2586,52,0.196,68,0.2074,83,0.238,95,0.2597,105,0.2597,115,0.2964,125,0.3367,135,0.3508"},"CountryCode":{"type":"string","description":"ISO-3166-1 alpha-3 code","example":"FRA"},"DataVersion":{"required":["name","version"],"properties":{"name":{"type":"string","description":"Identifies a data set, for example, a HRN, or a service specific identifier"},"version":{"type":"string","description":"The current version of this data set"}},"description":"Version of a specific data set"},"DepartureDelay":{"type":"integer","description":"The accumulated delay in seconds from the scheduled time of the event."},"DepartureStatus":{"type":"string","description":"Extensible enum: `scheduled` `cancelled` `additional` `replaced` `...`\nStatus of the departure\n\n* `scheduled`: A trip that is running as planned in the schedule.\n* `cancelled`: A trip that existed in the schedule but was removed.\n* `additional`: An extra trip that was added in addition to a running schedule, for example, to respond to sudden passenger load.\n* `replaced`: A trip that was in the schedule but is removed and replaced with `additional` trip, for example, to replace a broken vehicle or handle detour.\n","default":"scheduled","x-extensible-enum":["scheduled","cancelled","additional","replaced"]},"Distance":{"minimum":0,"type":"integer","description":"Distance in meters."},"Duration":{"type":"integer","description":"Duration in seconds."},"Energy":{"type":"number","description":"Energy in kilowatt hours (kWh)."},"ErrorResponse":{"required":["action","cause","code","correlationId","status","title"],"properties":{"title":{"type":"string","description":"Human-readable error description","example":"Input data failed validation"},"status":{"type":"integer","description":"HTTP status code","example":400},"code":{"type":"string","description":"Error code.\n\nAll error codes start with \"`E60`\".\n","example":"E600101"},"cause":{"type":"string","description":"Human-readable explanation for the error","example":"The input data in question does not comply with validation rules"},"action":{"type":"string","description":"Human-readable description of the action that can be taken to correct the error","example":"Request a valid id"},"correlationId":{"type":"string","description":"Auto-generated id that univocally identifies the request","example":"4199533b-6290-41db-8d79-edf4f4019a74"}},"description":"Response in case of error"},"Exclude":{"type":"object","properties":{"countries":{"type":"string","description":"A comma separated list of three-letter country codes (ISO-3166-1 alpha-3 code) that\nroutes will exclude.\n"}},"description":"Options to exclude strictly during the route calculation."},"FareReason":{"type":"string","description":"Extensible enum: `ride` `parking` `...`\nReason for the cost described in this `Fare` element.\n","x-extensible-enum":["ride","parking"]},"FunctionalClass":{"maximum":5,"minimum":1,"type":"integer","description":"Functional class is used to classify roads depending on the speed, importance and\nconnectivity of the road.\n\n* `1`: Roads allow for high volume, maximum speed traffic movement between and through major\n  metropolitan areas.\n* `2`: Roads are used to channel traffic to functional class 1 roads for travel between and\n  through cities in the shortest amount of time.\n* `3`: Roads that intersect functional class 2 roads and provide a high volume of traffic\n  movement at a lower level of mobility than functional class 2 roads.\n* `4`: Roads that provide for a high volume of traffic movement at moderate speeds between\n  neighbourhoods.\n* `5`: Roads with volume and traffic movement below the level of any other functional class.\n","format":"int32"},"HazardousGoodsRestriction":{"type":"string","description":"Extensible enum: `explosive` `gas` `flammable` `combustible` `organic` `poison` `radioactive` `corrosive` `poisonousInhalation` `harmfulToWater` `other` `any` `...`\nHazardous goods restriction applied during the trip.\n\n* `explosive`: Explosive material\n* `gas`: Gas\n* `flammable`: Flammable material\n* `combustible`: Combustible material\n* `organic`: Organic material\n* `poison`: Poison\n* `radioactive`: Radioactive material\n* `corrosive`: Corrosive material\n* `poisonousInhalation`: Materials that are poisonous upon inhalation\n* `harmfulToWater`: Materials that are harmful to water\n* `other`: Other types of hazardous materials\n* `any`: Any of the above types\n","x-extensible-enum":["explosive","gas","flammable","combustible","organic","poison","radioactive","corrosive","poisonousInhalation","harmfulToWater","other","any"]},"LocalizedString":{"required":["value"],"properties":{"value":{"type":"string","description":"String written in the language specified in the language property."},"language":{"type":"string","description":"Language in BCP47 format"}},"description":"String with optional language code.","example":{"value":"Invalidenstraße","language":"de"}},"Location":{"required":["lat","lng"],"properties":{"lat":{"type":"number","description":"Location of a point on the Earth north or south of the equator in decimal degrees.","format":"double","example":52.531677},"lng":{"type":"number","description":"Location of a place on the Earth east or west of the prime meridian in decimal degrees.","format":"double","example":13.381777},"elv":{"type":"number","description":"The elevation of a point above mean sea level in meters.","example":512.5}},"description":"Location on the Earth","example":{"lat":52.531677,"lng":13.381777}},"MaxSpeed":{"description":"Speed in meters per second, or \"unlimited\" indicating that the speed is unlimited, e.g., on a German autobahn","oneOf":[{"minimum":0,"type":"number"},{"type":"string","enum":["unlimited"]}]},"NoticeSeverity":{"type":"string","description":"Describes the impact a notice has on the resource to which the notice is attached.\n* critical - The notice must not be ignored, even if the type of notice is not known to the user. Any associated resource (e.g., route section) must not be used without further evaluation.\n* info - The notice is for informative purposes, but does not affect usability of the route.\n","enum":["critical","info"]},"ParkingLotPlaceType":{"type":"string","description":"Extensible enum: `parkAndRide` `...`","x-extensible-enum":["parkAndRide"]},"PartialTime":{"pattern":"^[012]\\d:[0-5]\\d:[0-6]\\d(\\.\\d+)?$","type":"string","description":"**RFC 3339**, section 5.6 as defined by `partial-time`."},"PedestrianSpeed":{"maximum":2,"minimum":0.5,"type":"number","description":"Pedestrian speed in meters per second","default":1},"Polyline":{"type":"string","description":"Line string in Flexible Polyline format.","example":"A05xgKuy2xCx9B7vUl0OhnR54EqSzpEl-HxjD3pBiGnyGi2CvwFsgD3nD4vB6e"},"Return":{"type":"string","description":"Defines which attributes are included in the response as part of data representation of a\n`Route` or `Section`.\n\n* `polyline` - Polyline for the route in Flexible Polyline Encoding.\n  Either a 2D polyline (without `elevation` specified), or a 3D polyline with the 3rd dimension type `Elevation` (with `elevation` specified).\n* `actions` - Actions (such as maneuvers or tasks) that must be taken to complete the section.\n* `instructions` - Include instructions in returned actions. Instructions are localized to the requested language.\n* `summary` - Include summary for the section.\n* `travelSummary` - Include summary for the travel portion of the section.\n* `turnByTurnActions` - Include all information necessary to support turn by turn guidance to complete the section.\n* `mlDuration` - Use a region-specific machine learning model to calculate route duration. **Disclaimer: This parameter is currently in beta release, and is therefore subject to breaking changes.**\n* `elevation` - Include elevation information in coordinate and geometry types. See e.g. `polyline` or `location`.\n* `routeHandle` - Encode calculated route and return a handle which can be used with\n  `routes/{routeHandle}` to decode the route at a later point in time.\n* `passthrough` - Include information on passthrough via waypoints in the section.\n* `incidents` - Include a list of all incidents applicable to each section.\n                Incidents are localized to the requested language.\n                This requires `incidents` to be specified as part of the `return` parameter.\n* `routingZones` - Include information about routing zones each section is going through.\n\nFollowing restrictions apply when specifying return parameter:\n\n* If `actions` is requested, then `polyline` must also be requested as well.\n* If `instructions` is requested, then `actions` must also be requested as well.\n* If `turnByTurnActions` is requested, then `polyline` must also be requested as well.\n* If at least one attribute is requested within the `spans` parameter, then `polyline` must be request as well\n","enum":["polyline","actions","instructions","summary","travelSummary","mlDuration","turnByTurnActions","elevation","routeHandle","passthrough","incidents","routingZones"]},"RoadInfoType":{"type":"string","description":"Type of the road (rural, urban, highway)","default":"urban","enum":["rural","urban","highway"]},"RouterMode":{"type":"string","description":"Mode of transport to be used for route calculation.","enum":["car","truck","pedestrian","bicycle","scooter","taxi","bus"]},"RoutingMode":{"type":"string","description":"Specifies which optimization is applied during route calculation.\n\n* `fast`: Route calculation from start to destination optimized by travel time. In many\n  cases, the route returned by the `fast` mode may not be the route with the fastest\n  possible travel time. For example, the routing service may favor a route that remains on\n  a highway, even if a faster travel time can be achieved by taking a detour or shortcut\n  through an inconvenient side road.\n* `short`: Route calculation from start to destination disregarding any speed information.\n  In this mode, the distance of the route is minimized, while keeping the route sensible.\n  This includes, for example, penalizing turns. Because of that, the resulting route will\n  not necessarily be the one with minimal distance.\n\nNotes:\n* The following Transport modes only support `fast` routingMode\n  - `bicycle`\n  - `bus`\n  - `pedestrian`\n  - `scooter`\n  - `taxi`\n","default":"fast","enum":["fast","short"]},"RoutingZone":{"properties":{"ref":{"type":"string","description":"A reference to a routing zone in HMC.\n\nThe standard representation of a routing zone reference has the following structure:\n`{catalogHrn}:{catalogVersion}:({layerId})?:{tileId}:{zoneId}`\n\nThe individual parts are:\n* `catalogHrn`: The Resource Name that identifies the source catalog of the routing zone * `catalogVersion`: The catalog version\n* `layerId` (optional): The layer inside the catalog where the routing zone is located, example: `environmental-zones`\n* `tileId`: The tile key of the partition/tile where the routing zone is located in the given version of the catalog\n* `zoneId`: The identifier of the referenced routing zone within the catalog In order to reduce reponse size, routing zone references can also be provided in a compact representation.\nIn compact form, parts of a reference are replaced by placeholders, which can be resolved using the `refReplacements` dictionary in the parent section.\nThe placeholder format is `\\$\\d+` and needs to be surrounded by columns or string start/end. It can be captured with the following regular expression: `(^|:)\\$\\d+(:|$)`\n\nExample of the aforementioned environmental zone reference in compact form: `$0:$1:3455277`\nWith the corresponding `refReplacements`:\n"},"type":{"type":"string","description":"The type of a routing zone.","x-extensible-enum":["environmental","vignette"]},"name":{"type":"string","description":"The routing zone's name."}},"description":"Information about a routing zone."},"Scooter":{"type":"object","properties":{"allowHighway":{"type":"boolean","description":"Specifies whether scooter is allowed on highway or not. This parameter is optional. If not provided, then by default scooter is not allowed to use highway. There is a similar parameter avoid[features]=controlledAccessHighway to disallow highway usage. avoid[features] takes precedence so if this parameter is also used then scooters are not allowed to use highways even if `allowHighway` is used with value as true.","default":false}},"description":"Scooter specific parameters"},"Spans":{"type":"string","enum":["walkAttributes","streetAttributes","carAttributes","truckAttributes","scooterAttributes","names","length","duration","baseDuration","countryCode","functionalClass","routeNumbers","speedLimit","maxSpeed","dynamicSpeedInfo","segmentId","segmentRef","consumption","routingZones","notices"]},"Speed":{"minimum":0,"type":"number","description":"Speed in meters per second"},"StreetAttributes":{"type":"string","description":"Extensible enum: `rightDrivingSide` `dirtRoad` `tunnel` `bridge` `ramp` `controlledAccess` `roundabout` `underConstruction` `dividedRoad` `privateRoad` `...`\n`StreetAttributes` is applied to a span of a route section and describes attribute flags of a street.\n* `rightDrivingSide`: Do vehicles have to drive on the right-hand side of the road or the left-hand side.\n* `dirtRoad`: This part of the route has an un-paved surface.\n* `tunnel`: This part of the route is a tunnel.\n* `bridge`: This part of the route is a bridge.\n* `ramp`: This part of the route is a ramp (usually connecting to/from/between highways).\n* `motorway`: This part of the route is a controlled access road (usually highways).\n* `roundabout`: This part of the route is a roundabout.\n* `underConstruction`: This part of the route is under construction.\n* `dividedRoad`: This part of the route uses a road with a physical or legal divider in the middle.\n* `privateRoad`: This part of the route uses a privately owned road.\n\nAs it is possible that new street attributes are supported in the future, unknown street attributes should be ignored.\n","x-extensible-enum":["rightDrivingSide","dirtRoad","tunnel","bridge","ramp","controlledAccess","roundabout","underConstruction","dividedRoad","privateRoad"]},"Time":{"type":"string","description":"**RFC 3339**, section 5.6 as defined by either `date-time` or `date-only` 'T' `partial-time` (ie no time-offset).","format":"date-time"},"TimeRestictedWeekdays":{"type":"string","enum":["mo","tu","we","th","fr","sa","su"]},"TimeWithAny":{"type":"string","description":"Specifies the time either as\n\n* \"**RFC 3339**, section 5.6 as defined by either `date-time` or `date-only` 'T'\n`partial-time` (ie no time-offset)\", or\n* the special value `any` which stand for unspecified time\n"},"TrafficIncidentCriticality":{"type":"string","description":"Describes the impact an incident has on the route.\n* critical - The part of the route the incident affects is not usable.\n* major - Major impact on duration, e.g. stop and go\n* minor - Minor impact on duration, e.g. traffic jam\n* low - Very little impact on duration, e.g. slightly increased traffic\n","enum":["critical","major","minor","low"]},"TrafficIncidentType":{"type":"string","description":"Extensible enum: `accident` `congestion` `construction` `disabledVehicle` `massTransit` `plannedEvent` `roadHazard` `roadClosure` `weather` `laneRestriction` `other` `...`\nAn open list of possible incident causes / types.\nNote: Since new types are expected to appear, it is important to check for unknown types when parsing this value.\n","x-extensible-enum":["accident","congestion","construction","disabledVehicle","massTransit","plannedEvent","roadHazard","roadClosure","weather","laneRestriction","other"]},"TrailerCountRange":{"properties":{"from":{"minimum":0,"type":"integer","description":"Inclusive minimum of trailer count.","format":"int32"},"to":{"minimum":0,"type":"integer","description":"Inclusive maximum of trailer count. If not set, maximum trailer count is unbounded.","format":"int32"}},"description":"Constrains the restriction to vehicles with number of trailers within specified range."},"TransitIncidentEffect":{"type":"string","description":"Extensible enum: `cancelledService` `reducedService` `additionalService` `modifiedService` `delays` `detour` `stopMoved` `other` `...`\nAn open list of possible incident effects.\nNote: Since new types are expected to appear, it is important to check for unknown types when parsing this value.\n","x-extensible-enum":["cancelledService","reducedService","additionalService","modifiedService","delays","detour","stopMoved","other"]},"TransitIncidentType":{"type":"string","description":"Extensible enum: `technicalProblem` `strike` `demonstration` `accident` `holiday` `weather` `maintenance` `construction` `policeActivity` `medicalEmergency` `other` `...`\nAn open list of possible incident causes / types.\nNote: Since new types are expected to appear, it is important to check for unknown types when parsing this value.\n","x-extensible-enum":["technicalProblem","strike","demonstration","accident","holiday","weather","maintenance","construction","policeActivity","medicalEmergency","other"]},"TruckAxleCountRange":{"properties":{"from":{"minimum":2,"type":"integer","description":"Inclusive minimum of axle count.","format":"int32"},"to":{"minimum":2,"type":"integer","description":"Inclusive maximum of axle count. If not set, maximum axle count is unbounded.","format":"int32"}},"description":"Constrains the restriction to trucks with number of axles within specified range."},"TruckType":{"type":"string","description":"Specifies the type of truck\n\n* `straight`: a truck on a single frame with a permanently attached cargo area\n* `tractor`: a towing vehicle that can pull one or more semi-trailers (aka semi-truck)\n","enum":["straight","tractor"]},"TunnelCategory":{"type":"string","description":"Specifies the tunnel category used to restrict transport of specific goods.\n","enum":["B","C","D","E"]},"TurnActionDirection":{"type":"string","description":"Direction of the turn. `middle` is only used by the `keep` action.","enum":["middle","right","left"]},"TurnActionSeverity":{"type":"string","description":"Tightness of the turn. Optional in the `turn` action, unused by other actions.\n\n* `light`: indicates making a light turn\n* `quite`: indicates making a regular turn\n* `heavy`: indicates making a heavy turn\n","enum":["light","quite","heavy"]},"Units":{"type":"string","description":"Units of measurement used, for example, in guidance instructions. The default is `metric`.","enum":["metric","imperial"]},"Uri":{"type":"string","description":"An URL address that links to a particular resource.","format":"uri"},"Vehicle":{"type":"object","properties":{"hovOccupancy":{"minimum":1,"type":"integer","description":"Number of occupants (defined as occupying a restraint device) in the vehicle.\nThis value affects the ability of the router to use HOV (High-Occupancy Vehicles) restricted lanes.\n\nLimitations:\n  * only valid for `transportMode=car`.\n  * currently, any value over 1 is interpreted as being able to use any HOV lane (including, e.g. those restricted to 3+ passengers).\n","default":1},"speedCap":{"maximum":70,"minimum":1,"type":"number","description":"Specifies the maximum speed, in m/s, which the user wishes not to exceed.\nThis parameter affects route ETA and consumption calculation.\n\nLimitations:\n  * valid for following transport modes: `car`, `truck` and `scooter`\n\nNotes:\n  * Car and Truck mode updates route ETA\n  * Scooter mode updates route optimization and ETA.\n"}},"description":"**Disclaimer: these parameters are work in progress and functionality is not complete**\n\nAdditional generic details about the vehicle for which the route is calculated.\n\nCurrently, `hovOccupancy` and `speedCap` are defined, with limited functionality\n"},"WalkAttributes":{"type":"string","description":"Extensible enum: `stairs` `park` `indoor` `open` `noThrough` `tollRoad` `...`\nWalkAttributes are applied to a span of a route section and describe walk-related attribute\nflags.\n\n* `stairs`: This part of the route is using stairs.\n* `park`: This part of the route is located inside a park.\n* `indoor`: This part of the route is located inside a venue.\n* `open`: This part of the route is open to walking.\n* `noThrough`: This part of the route can only be entered if the destination is located there.\n* `tollRoad`: This part of the route is restricted with a fee (or toll).\n","x-extensible-enum":["stairs","park","indoor","open","noThrough","tollRoad"]},"Waypoint":{"type":"string","description":"A location defining an origin, destination or via point for a route or an isoline.\n\nFormat: `Place[WaypointOptions]`\n\n* Place: `{lat},{lng}[PlaceOptions]`\n* PlaceOptions: `;option1=value1;option2=value2...`\n* WaypointOptions: `!option1=value1!option2=value2...`\n\nA waypoint consists of:\n* Exactly one place\n* Optional settings for the place\n* Optional settings for the waypoint itself\n\nSupported place options:\n* `course`: int, degrees clock-wise from north. Indicates the desired direction from the place. For example, `90` indicating `east`. Often combined with `radius` and/or `minCourseDistance`. This parameter takes preference over `matchSideOfStreet`.\n* `sideOfStreetHint`: `{lat},{lng}`. Indicates the side of the street that should be used. For example, if the location is to the left of the street, the router will prefer using that side in case the street has dividers. For example, `52.511496,13.304140;sideOfStreetHint=52.512149,13.304076` indicates that the `north` side of the street should be preferred. This options is required, if `matchSideOfStreet` is set to `always`.\n* `matchSideOfStreet`: enum `[always, onlyIfDivided]`. Specifies how the location set by `sideOfStreetHint` should be handled. Requires `sideOfStreetHint` to be specified as well. Note the exception above when combined with `course`.\n  + `always` : Always prefer the given side of street.\n  + `onlyIfDivided`: Only prefer using side of street set by `sideOfStreetHint` in case the street has dividers. This is the default behavior.\n* `nameHint`: string. Causes the router to look for the place with the most similar name. The typical examples include: `North` being used to differentiate between interstates `I66 North` and `I66 South`, `Downtown Avenue` being used to correctly select a residental street.\n* `radius`: int, meters. Instructs the router to consider all places within the given radius as potential candidates for route calculation. This can be either because it is not important which place is used, or because it is unknown. Radiuses wider than 200 meters are not supported.\n* `minCourseDistance`: int, meters. Instructs the routing service to try to find a route that avoids actions for the indicated distance. For example, if the origin is determined by a moving vehicle, the user might not have time to react to early actions.\n\nSupported waypoint options:\n* `stopDuration`: desired duration for the stop, in seconds.\n* `passThrough`: boolean. Asks the router to avoid the following during route calculation:\n  + Introducing a stop at the waypoint.\n  + Splitting the route into sections.\n  + Changing the direction of travel.\n\nFollowing scenarios is not supported for `passThrough` parameter:\n  + Setting both `stopDuration` to a value greater than 0 and `passThrough=true`.\n  + Setting `passThrough=true` for `origin` or `destination` of a route.\n  The default value is `false`.\n"},"Agency":{"required":["id","name"],"properties":{"id":{"type":"string","description":"Unique code of the agency. Specifies if the same agency is used on different sections of the same route."},"name":{"type":"string","description":"Human readable name of the owner of the transport service."},"website":{"description":"Link to the agency's website.","allOf":[{"$ref":"#/components/schemas/Uri"}]},"icon":{"description":"Agency icon url","allOf":[{"$ref":"#/components/schemas/Uri"}]}},"description":"Contains information about a particular agency."},"BaseAction":{"required":["action","duration"],"properties":{"action":{"type":"string","description":"The type of the action.\n\n**NOTE:** The list of possible actions may be extended in the future. The client application should handle such a case gracefully.\n"},"duration":{"description":"Estimated duration of this action (in seconds). Actions last until the next action, or the end of the route in case of the last one.","allOf":[{"$ref":"#/components/schemas/Duration"}]},"instruction":{"type":"string","description":"Description of the action (e.g. Turn left onto Minna St.)."}},"description":"An action to be performed between sections or during a section."},"BasePlace":{"required":["location","type"],"properties":{"name":{"type":"string","description":"Location name"},"waypoint":{"type":"integer","description":"If present, this place corresponds to the waypoint in the request with the same index."},"type":{"type":"string","description":"Place type. Each place type can have extra attributes.\n\n**NOTE:** The list of possible place types could be extended in the future.\nThe client application is expected to handle such a case gracefully.\n"},"location":{"description":"The position of this location\n\nThis position was used in route calculation. It may be different to the original position provided in the request.\n","allOf":[{"$ref":"#/components/schemas/Location"}]},"originalLocation":{"description":"If present, the original position of this location provided in the request.","allOf":[{"$ref":"#/components/schemas/Location"}]}}},"BaseSummary":{"required":["duration","length"],"properties":{"duration":{"$ref":"#/components/schemas/Duration"},"length":{"$ref":"#/components/schemas/Distance"}},"description":"Total value of key attributes for a route section."},"ChargingConnectorAttributes":{"required":["connectorType","power","supplyType"],"properties":{"power":{"type":"number","description":"Power supplied by the suggested connector in kW."},"current":{"type":"number","description":"Current of the suggested connector in Amperes."},"voltage":{"type":"number","description":"Voltage of the suggested connector in Volts."},"supplyType":{"description":"Supply type of the suggested connector.\n","allOf":[{"$ref":"#/components/schemas/ChargingSupplyType"}]},"connectorType":{"description":"Suggested connector for charging at this station","allOf":[{"$ref":"#/components/schemas/ChargingConnectorType"}]}},"description":"Details of the connector that is suggested to be used in the section's `postAction` for charging."},"ChargingStationBrand":{"properties":{"name":{"type":"string","description":"Charging station brand name"},"hrn":{"type":"string","description":"Charging station brand unique ID. It is generated as a brand name hash.\n"}},"description":"Information regarding the charging station brand"},"DynamicSpeedInfo":{"required":["baseSpeed","trafficSpeed","turnTime"],"properties":{"trafficSpeed":{"description":"Traffic-enabled speed, which is the estimated speed considering traffic-relevant constraints.\n","allOf":[{"$ref":"#/components/schemas/Speed"}]},"baseSpeed":{"description":"Estimated speed without considering any traffic-related constraints.","allOf":[{"$ref":"#/components/schemas/Speed"}]},"turnTime":{"description":"Turn time estimate considering traffic and transport mode needed for turning from this segment into the next.\n","allOf":[{"$ref":"#/components/schemas/Duration"}]}},"description":"Describes dynamic speed information, such as traffic speed, estimated speed without traffic, and turn time.\n"},"ExitInfo":{"properties":{"number":{"type":"array","description":"Number of the exit (e.g. '18')","items":{"$ref":"#/components/schemas/LocalizedString"}}},"description":"Exit information attached to an offset action","example":{"exit":{"number":[{"value":"15","language":"de"}]}}},"HealthResponseFailSchema":{"properties":{"status":{"type":"string","description":"Health status of the service:\n\n* `ok` - the service is operating normally\n* `fail` - the service is currently encountering a failure\n","enum":["fail"]}},"description":"Returns the health of the service"},"HealthResponseOKSchema":{"properties":{"status":{"type":"string","description":"Health status of the service:\n\n* `ok` - the service is operating normally\n* `fail` - the service is currently encountering a failure\n","enum":["ok"]}},"description":"Returns the health of the service"},"Notice":{"required":["code"],"properties":{"title":{"type":"string","description":"Human-readable notice description.","example":"No route found"},"code":{"type":"string","description":"Notice code.","example":"noRouteFound"},"severity":{"$ref":"#/components/schemas/NoticeSeverity"},"details":{"type":"array","description":"Additional details about the notice","items":{"$ref":"#/components/schemas/BaseNoticeDetail"}}},"description":"A notice contains important notifications."},"PedestrianMode":{"type":"string","description":"Extensible enum: `pedestrian` `...`\nPedestrian mode of transport.\n\nSince the supported pedestrian modes may be extended in the future, the pedestrian mode should be hidden when an unknown mode is encountered.\n","default":"pedestrian","x-extensible-enum":["pedestrian"]},"RoadInfo":{"properties":{"type":{"$ref":"#/components/schemas/RoadInfoType"},"name":{"type":"array","description":"Name of the road","items":{"$ref":"#/components/schemas/LocalizedString"}},"number":{"type":"array","description":"Route name or number (e.g. 'M25')","items":{"$ref":"#/components/schemas/LocalizedString"}},"toward":{"type":"array","description":"Names of destinations on sign which can be reached when going in that direction","items":{"$ref":"#/components/schemas/LocalizedString"}}},"description":"Road information attached to an offset action","example":{"fennstrasse":{"type":"street","name":[{"value":"Fennstraße","language":"de"}],"number":[{"value":"B96","language":"de"}],"toward":[{"value":"Reinickendorf","language":"de"}]}}},"RoutingErrorResponse":{"required":["action","cause","code","correlationId","status","title"],"properties":{"title":{"type":"string","description":"Human-readable error description","example":"Input data failed validation"},"status":{"type":"integer","description":"HTTP status code","example":400},"code":{"type":"string","description":"Machine readable service error code.\n\nAll error codes of this service start with \"`E605`\". The last three digits describe a specific error. Provide this error code when contacting support.\n\n**NOTE:** Please note that the list of possible error codes could be extended in the future. The client application is expected to handle such a case gracefully.\n\n| Code      | Reason  |\n| --------- | ------- |\n| `E60500X` | Malformed query. Typically due to invalid values such as `transportMode=spaceShuttle` or missing required fields. Check the error message for details. |\n| `E605010` | Invalid combination of truck and transport mode. Check `truck` for valid truck transport modes. |\n| `E605011` | Invalid combination of avoid feature `difficultTurns` and transport mode. Check `avoid` for details. |\n| `E605012` | Invalid combination of transport mode and routing mode. Check `routingMode` for a list of supported combinations. |\n| `E605013` | Invalid return options. Check `return` for valid combinations of values. |\n| `E605014` | Invalid language code. Check `lang` for details on how valid language codes look. |\n| `E605015` | Too many alternatives. Check `alternatives` for the maximum number of alternatives allowed. |\n| `E605016` | Invalid exclude countries. Check `exclude` for details. |\n| `E605017` | `spans` contains a value whose dependency has not been requested |\n| `E605030` | Invalid EV options. Check `ev` for details on how valid EV options look. |\n| `E605032` | Invalid transport mode for speed cap, check `vehicle[speedCap]` for details. |\n| `E605033` | Invalid combination of scooter and transport mode. Check `scooter` for valid scooter transport modes. |\n| `E605034` | Invalid Speed Cap, check `vehicle[speedCap]` for details. |\n| `E605035` | MLDuration is not supported with `vehicle[speedCap]` parameter. |\n| `E605040` | Invalid combination of EV and transport mode. Check `ev` for details. |\n| `E605041` | Invalid combination of EV and routing mode. Check `ev` for details. |\n| `E605042` | Invalid combination of EV and alternatives. Check `ev` for details. |\n| `E605043` | Invalid combination of EV and avoid options. Check `ev` for details. |\n| `E605044` | Invalid combination of EV and exclude options. Check `ev` for details. |\n| `E605101` | Credentials not allowed for calculating routes in Japan. |\n| `E605201` | RouteHandle not valid (anymore). (Re-)calculate route to retrieve new handle. |\n| `E605301` | Pedestrian options are only supported for transport mode `pedestrian`. |\n| `E6055XX` | Internal server error. |\n","example":"E605001"},"cause":{"type":"string","description":"Human-readable explanation for the error","example":"The input data in question does not comply with validation rules"},"action":{"type":"string","description":"Human-readable description of the action that can be taken to correct the error","example":"Request a valid id"},"correlationId":{"type":"string","description":"Auto-generated id that univocally identifies the request","example":"4199533b-6290-41db-8d79-edf4f4019a74"}},"description":"Response in case of error"},"TrafficIncident":{"properties":{"description":{"type":"string","description":"A human readable description of the incident","example":"closed due to roadworks"},"type":{"$ref":"#/components/schemas/TrafficIncidentType"},"criticality":{"$ref":"#/components/schemas/TrafficIncidentCriticality"},"validFrom":{"$ref":"#/components/schemas/Time"},"validUntil":{"$ref":"#/components/schemas/Time"}},"description":"An incident describes a temporary event on a route network link.\nIt typically refers to a real world incident (accident, road construction, weather condition, etc.)\non a street or street segment\n"},"TransitIncident":{"required":["effect","type"],"properties":{"summary":{"type":"string","description":"A human readable summary of the incident","example":"The subway is closed each night between 1 AM and 5 AM."},"description":{"type":"string","description":"A human readable description of the incident","example":"The subway is closed each night between 1 AM and 5 AM while we clean our trains and stations. We are running extra bus service overnight."},"type":{"$ref":"#/components/schemas/TransitIncidentType"},"effect":{"$ref":"#/components/schemas/TransitIncidentEffect"},"validFrom":{"$ref":"#/components/schemas/Time"},"validUntil":{"$ref":"#/components/schemas/Time"},"url":{"description":"Link to the original incident published at the agency website","allOf":[{"$ref":"#/components/schemas/Uri"}]}},"description":"An incident describes disruptions on the transit network.\nDisruptions scale from delays to service cancellations.\n"},"TransitModeOutput":{"title":"Modes","type":"string","description":"Extensible enum: `highSpeedTrain` `intercityTrain` `interRegionalTrain` `regionalTrain` `cityTrain` `bus` `ferry` `subway` `lightRail` `privateBus` `inclined` `aerial` `busRapid` `monorail` `carShuttleTrain` `flight` `spaceship` `...`\nTransit mode of transport in the route response\n","x-extensible-enum":["highSpeedTrain","intercityTrain","interRegionalTrain","regionalTrain","cityTrain","bus","ferry","subway","lightRail","privateBus","inclined","aerial","busRapid","monorail","carShuttleTrain","flight","spaceship"]},"TruckTypeWithDefault":{"type":"string","description":"Specifies the type of truck\n\n* `straight`: a truck on a single frame with a permanently attached cargo area\n* `tractor`: a towing vehicle that can pull one or more semi-trailers (aka semi-truck)\n","default":"straight","enum":["straight","tractor"]},"VehicleMode":{"type":"string","description":"Extensible enum: `car` `truck` `scooter` `...`\nVehicle mode of transport.\n\nSince the supported vehicle modes may be extended in the future, the vehicle mode should be hidden when an unknown mode is encountered.\n","default":"car","x-extensible-enum":["car","truck","scooter"]},"VehicleRestriction":{"required":["type"],"properties":{"title":{"type":"string","description":"Detail title"},"cause":{"type":"string","description":"Cause of the notice"},"type":{"type":"string","description":"Detail type. Each type of detail might contain extra attributes.\n\n**NOTE:** The list of possible detail types may be extended in the future.\nThe client application is expected to handle such a case gracefully.\n"},"forbiddenHazardousGoods":{"type":"array","description":"Hazardous goods restrictions applied during the trip.\n\nThis condition is met when the vehicle's shippedHazardousGoods\ncontains any of the items in this array.\n","items":{"$ref":"#/components/schemas/HazardousGoodsRestriction"}},"maxGrossWeight":{"minimum":0,"type":"integer","description":"Contains max permitted gross weight, in kilograms.\n\nThis condition is met when the vehicle's `grossWeight` exceeds this value.\n","format":"int32"},"maxWeightPerAxle":{"minimum":0,"type":"integer","description":"Contains max permitted weight per axle, in kilograms.\n\nThis condition is met when the vehicle's `weightPerAxle` exceeds this value.\n","format":"int32"},"maxHeight":{"minimum":0,"type":"integer","description":"Contains max permitted height, in centimeters.\n\nThis condition is met when the vehicle's `height` exceeds this value.\n","format":"int32"},"maxWidth":{"minimum":0,"type":"integer","description":"Contains max permitted width, in centimeters.\n\nThis condition is met when the vehicle's `width` exceeds this value.\n","format":"int32"},"maxLength":{"minimum":0,"type":"integer","description":"Contains max permitted length, in centimeters.\n\nThis condition is met when the vehicle's `length` exceeds this value.\n","format":"int32"},"axleCount":{"description":"Constrains the restriction to trucks with number of axles within specified range.\n\nThis condition is met when the vehicle's `axleCount` is within the range specified.\n","allOf":[{"$ref":"#/components/schemas/TruckAxleCountRange"}]},"tunnelCategory":{"description":"Specifies the tunnel category used to restrict transport of specific goods.\n\nThis condition is met when the value exceeds the tunnel category specified\nby the vehicle's `tunnelCategory`\n","allOf":[{"$ref":"#/components/schemas/TunnelCategory"}]},"timeDependent":{"type":"boolean","description":"Indicates that restriction depends on time.\n"},"truckType":{"description":"Constrains the restriction to a specific type of truck.\n\nThis condition is met if the `truck[type]` request parameter matches this value.\n","allOf":[{"$ref":"#/components/schemas/TruckType"}]},"trailerCount":{"description":"Constrains the restriction to trucks with number of axles within specified range.\n\nThis condition is met when the vehicle's `trailerCount` is within the range specified.\n","allOf":[{"$ref":"#/components/schemas/TrailerCountRange"}]}},"description":"Contains details about violated restrictions.\n\nCertain properties represent conditions to be evaluated, e.g., according to vehicle properties.\nThe restriction is violated if and only if all of the conditions present are met.\n","example":{"$ref":"#/components/examples/restrictionExample"}},"VersionResponse":{"required":["apiVersion"],"properties":{"apiVersion":{"type":"string","description":"The current version of the API."},"serviceVersion":{"type":"string","description":"The current version of the service."},"dataVersions":{"type":"array","description":"Returns the versions of data sets used by the service.","items":{"$ref":"#/components/schemas/DataVersion"}}},"description":"Returns the versions of the service components."},"AccessPointPlace":{"required":["location","type"],"properties":{"name":{"type":"string","description":"Location name"},"waypoint":{"type":"integer","description":"If present, this place corresponds to the waypoint in the request with the same index."},"type":{"type":"string","description":"Place type. Each place type can have extra attributes.\n\n**NOTE:** The list of possible place types could be extended in the future.\nThe client application is expected to handle such a case gracefully.\n"},"location":{"description":"The position of this location\n\nThis position was used in route calculation. It may be different to the original position provided in the request.\n","allOf":[{"$ref":"#/components/schemas/Location"}]},"originalLocation":{"description":"If present, the original position of this location provided in the request.","allOf":[{"$ref":"#/components/schemas/Location"}]}},"description":"Access point to a venue/station"},"Attribution":{"required":["id","text"],"properties":{"id":{"type":"string","description":"Unique identifier for the web link. It is used to deduplicate links defined in multiple sections."},"href":{"$ref":"#/components/schemas/Uri"},"text":{"type":"string","description":"Text describing the url address (e.g. The example website)."},"hrefText":{"type":"string","description":"The interactive (or clickable) portion of the text. If not present (default), the entire content of the text attribute will be considered.\n"},"type":{"$ref":"#/components/schemas/AttributionLinkType"}},"description":"The URL address to an external resource."},"BoardAction":{"description":"An action to board a ferry.","allOf":[{"$ref":"#/components/schemas/BaseAction"}]},"ChargingAction":{"required":["action","duration"],"properties":{"action":{"type":"string","description":"The type of the action.\n\n**NOTE:** The list of possible actions may be extended in the future. The client application should handle such a case gracefully.\n"},"duration":{"description":"Estimated duration of this action (in seconds). Actions last until the next action, or the end of the route in case of the last one.","allOf":[{"$ref":"#/components/schemas/Duration"}]},"instruction":{"type":"string","description":"Description of the action (e.g. Turn left onto Minna St.)."},"consumablePower":{"type":"number","description":"Maximum charging power (in kW) available to the vehicle, based on the properties of the charging\nstation and the vehicle.\n"},"arrivalCharge":{"type":"number","description":"Estimated vehicle battery charge before this action (in kWh).\n"},"targetCharge":{"type":"number","description":"Level to which vehicle battery should be charged by this action (in kWh).\n"}},"description":"An action to charge the vehicle.\n"},"ChargingSetupAction":{"description":"An action to prepare for vehicle charging. Represents the time spent setting up for charging (e.g., payment processing), independent\nof the time required to actually charge the vehicle.\n","allOf":[{"$ref":"#/components/schemas/BaseAction"}]},"ChargingStationPlace":{"required":["location","type"],"properties":{"name":{"type":"string","description":"Human readable name of this charging station"},"waypoint":{"type":"integer","description":"If present, this place corresponds to the waypoint in the request with the same index."},"type":{"type":"string","description":"Place type. Each place type can have extra attributes.\n\n**NOTE:** The list of possible place types could be extended in the future.\nThe client application is expected to handle such a case gracefully.\n"},"location":{"description":"The position of this location\n\nThis position was used in route calculation. It may be different to the original position provided in the request.\n","allOf":[{"$ref":"#/components/schemas/Location"}]},"originalLocation":{"description":"If present, the original position of this location provided in the request.","allOf":[{"$ref":"#/components/schemas/Location"}]},"id":{"type":"string","description":"Identifier of this charging station"},"connectorAttributes":{"$ref":"#/components/schemas/ChargingConnectorAttributes"},"brand":{"$ref":"#/components/schemas/ChargingStationBrand"}},"description":"A charging station"},"DeboardAction":{"description":"An action to disembark a ferry.","allOf":[{"$ref":"#/components/schemas/BaseAction"}]},"EV":{"required":["freeFlowSpeedTable"],"type":"object","properties":{"freeFlowSpeedTable":{"example":"0,0.2394,14,0.2394,36,0.2586,52,0.196,68,0.2074,83,0.238,95,0.2597,105,0.2597,115,0.2964,125,0.3367,135,0.3508","allOf":[{"$ref":"#/components/schemas/ConsumptionSpeedTable"}]},"trafficSpeedTable":{"description":"Function curve specifying consumption rate at a given traffic-reduced speed on a flat stretch of road.\n\nSee `freeFlowSpeedTable` for a description of the string format.\n","allOf":[{"$ref":"#/components/schemas/ConsumptionSpeedTable"}]},"ascent":{"minimum":0,"type":"number","description":"Rate of energy consumed per meter rise in elevation (in Wh/m, i.e., Watt-hours per meter).\n"},"descent":{"minimum":0,"type":"number","description":"Rate of energy recovered per meter fall in elevation (in Wh/m, i.e., Watt-hours per meter).\n"},"auxiliaryConsumption":{"minimum":0,"type":"number","description":"Rate of energy (in Wh/s) consumed by the vehicle's auxiliary systems (e.g., air conditioning, lights).\nThe value represents the number of Watt-hours consumed per second of travel.\n"},"initialCharge":{"minimum":0,"type":"number","description":"Charge level of the vehicle's battery at the start of the route (in kWh).\nValue must be less than or equal to the value of `maxCharge`.\n"},"maxCharge":{"minimum":0,"type":"number","description":"Total capacity of the vehicle's battery (in kWh).\n"},"chargingCurve":{"type":"string","description":"Function curve describing the maximum battery charging rate (in kW) at a given charge level (in kWh).\n\nThe format of the string is a comma-separated list of numbers, as follows:\n\n```\n<CHARGE_0>,<RATE_0>,<CHARGE_1>,<RATE_1>,...,<RATE_N>,<CHARGE_N>\n```\n\nwhere charge values are strictly increasing, non-negative floating-point values in units\nof (kWh), and rate values are positive floating point values in units of (kW).\n\nCharge values must cover the entire range of `[0, maxChargeAfterChargingStation`]. The\ncharging curve is piecewise constant, e.g., for any charge in the range `[CHARGE_0,\nCHARGE_1)`, the value of the function is `RATE_0`.\n","example":"0,207,28.761,207,29.011,173,43.493,173,43.743,145,51.209,145,51.459,113,56.120,113,56.370,87,80.0,10"},"connectorTypes":{"type":"string","description":"Comma-separated list of connector types that are compatible with the vehicle. If `makeReachable` is set to `true`,\nthen only stations with any of these connector types will be evaluated as a potential charging stop.\nFor stations with multiple compatible connectors, the charging time is based on the connector type with the highest power rating among them.\n\nCurrently supported connector types are:\n  * `iec62196Type1Combo`:  Type 1 Combo connector, commonly called \"SAE J1772\"\n  * `iec62196Type2Combo`:  Type 2 Combo connector, commonly called \"Mennekes\"\n  * `chademo`: CHAdeMO connector\n  * `tesla`: Tesla connector\n","example":"iec62196Type1Combo,chademo"},"maxChargingVoltage":{"minimum":0,"type":"number","description":"Maximum charging voltage supported by the vehicle's battery (in Volt).\n"},"maxChargingCurrent":{"minimum":0,"type":"number","description":"Maximum charging current supported by the vehicle's battery (in Ampere).\n"},"maxChargeAfterChargingStation":{"minimum":0,"type":"number","description":"Maximum charge to which the battery should be charged at a charging station (in kWh).\nValue must be less than or equal to the value of `maxCharge`.\n"},"minChargeAtChargingStation":{"minimum":0,"type":"number","description":"Minimum charge when arriving at a charging station (in kWh).\nValue must be less than the value of `maxChargeAfterChargingStation`.\n"},"minChargeAtDestination":{"minimum":0,"type":"number","description":"Minimum charge at the final route destination (in kWh).\nValue must be less than the value of `maxChargeAfterChargingStation`.\n"},"chargingSetupDuration":{"minimum":0,"type":"integer","description":"Time spent after arriving at a charging station, but before actually charging, e.g., time spent for payment processing (in seconds).\n","format":"int32"},"preferredBrands":{"type":"string","description":"Comma-separated list of charging station brands. If `makeReachable` is set to `true`, then charging stations from the specified brands\nwill be preferred as potential charging stops, even if this makes travel time longer (up to 15 minutes per charging stop).\n"},"makeReachable":{"type":"boolean","description":"When set to `true`, the router ensures that the calculated route is reachable within the given constraints\n(i.e., `minChargeAtChargingStation`, `minChargeAtDestination`). If necessary, charging stations are added to the route\nto achieve reachability.\n\nThe following conditions must be met in order to enable this option:\n* `transportMode=car`\n* `routingMode=fast`\n* No `avoid` options requested\n* No `alternatives` requested\n"}},"description":"**Disclaimer: This parameter is currently in beta release, and is therefore subject to breaking changes.**\n\nEV parameters to be used for calculating consumption and for calculating EV routes with\nautomatically added charging stations.\n\nThe following attributes are required for calculating consumption:\n* `freeFlowSpeedTable`\n* `ascent`\n* `descent`\n\nThe following attributes are additionally required in order to calculate reachable routes:\n\n* `initialCharge`\n* `maxCharge`\n* `connectorTypes`\n* `chargingCurve`\n* `maxChargeAfterChargingStation`\n* `makeReachable` set to `true`\n\nAll remaining attributes are optional.\n"},"OffsetAction":{"required":["action","duration"],"properties":{"action":{"type":"string","description":"The type of the action.\n\n**NOTE:** The list of possible actions may be extended in the future. The client application should handle such a case gracefully.\n"},"duration":{"description":"Estimated duration of this action (in seconds). Actions last until the next action, or the end of the route in case of the last one.","allOf":[{"$ref":"#/components/schemas/Duration"}]},"instruction":{"type":"string","description":"Description of the action (e.g. Turn left onto Minna St.)."},"offset":{"type":"integer","description":"Offset of a coordinate in the section's polyline."},"length":{"description":"Estimated length of this action (in meters). Actions extend until the next action, or the end of the route in case of the last one.","allOf":[{"$ref":"#/components/schemas/Distance"}]},"currentRoad":{"description":"Attributes of the current road","allOf":[{"$ref":"#/components/schemas/RoadInfo"}]},"nextRoad":{"description":"Attributes of the next road","allOf":[{"$ref":"#/components/schemas/RoadInfo"}]},"exitSign":{"description":"Attributes of the road exit","allOf":[{"$ref":"#/components/schemas/ExitInfo"}]}},"description":"An action to be performed at or during a specific portion of a section.\n\n* `depart`: departure maneuver, such as \"Start at\"\n* `arrive`: arrival maneuver, such as \"Arrive at\"\n* `continue`: continue maneuver, such as \"Continue on\"\n"},"PedestrianSpan":{"properties":{"offset":{"minimum":0,"type":"integer","description":"Offset of a coordinate in the section's polyline.\n","format":"int32"},"length":{"$ref":"#/components/schemas/Distance"},"duration":{"$ref":"#/components/schemas/Duration"},"streetAttributes":{"type":"array","description":"`StreetAttributes` is applied to a span of a route section and describes attribute flags of a street.\n* `rightDrivingSide`: Do vehicles have to drive on the right-hand side of the road or the left-hand side.\n* `dirtRoad`: This part of the route has an un-paved surface.\n* `tunnel`: This part of the route is a tunnel.\n* `bridge`: This part of the route is a bridge.\n* `ramp`: This part of the route is a ramp (usually connecting to/from/between highways).\n* `motorway`: This part of the route is a controlled access road (usually highways).\n* `roundabout`: This part of the route is a roundabout.\n* `underConstruction`: This part of the route is under construction.\n* `dividedRoad`: This part of the route uses a road with a physical or legal divider in the middle.\n* `privateRoad`: This part of the route uses a privately owned road.\n\nAs it is possible that new street attributes are supported in the future, unknown street attributes should be ignored.\n","items":{"$ref":"#/components/schemas/StreetAttributes"}},"walkAttributes":{"type":"array","description":"Accessibility and walk-related attribute flags.\n\n* `stairs`: This part of the route is a staircase.\n* `park`: This part of the route is in a park.\n* `indoor`: This part of the route is inside a venue.\n* `open`:  Describes whether this part of the route can be traversed.\n* `noThrough`:  A part of the route you can only enter if your destination is located there.\n* `tollRoad`: Access to this part of the route is restricted with a fee (or toll).\n\nAs it is possible that new attributes are supported in the future, unknown attributes should be ignored.\n","items":{"$ref":"#/components/schemas/WalkAttributes"}},"carAttributes":{"type":"array","description":"Car specific `AccessAttributes`.\n\n`AccessAttributes` is applied to a span of a route section and describes access flags of a street.\n* `open`:  Describes if you are allowed to traverse this stretch of the route.\n* `noThrough`:  A part of the route you can only enter if your destination is located there.\n* `tollRoad`: Access to this part of the route is restricted with a fee (or toll).\n\nAs it is possible that new access attributes are supported in the future, unknown access attributes should be ignored.\n","items":{"$ref":"#/components/schemas/AccessAttributes"}},"truckAttributes":{"type":"array","description":"Truck specific `AccessAttributes`.\n\n`AccessAttributes` is applied to a span of a route section and describes access flags of a street.\n* `open`:  This part of the route is open to trucks.\n* `noThrough`:  This part of the route can only be entered if the destination is located there.\n* `tollRoad`: This part of the route is restricted with a fee (or toll).\n\nAs it is possible that new access attributes are supported in the future, unknown access attributes should be ignored.\n","items":{"$ref":"#/components/schemas/AccessAttributes"}},"scooterAttributes":{"type":"array","description":"Scooter specific `AccessAttributes`.\n\n`AccessAttributes` is applied to a span of a route section and describes access flags of a street.\n* `open`:  This part of the route is open to scooters.\n\nAs it is possible that new access attributes are supported in the future, unknown access attributes should be ignored.\n","items":{"$ref":"#/components/schemas/AccessAttributes"}},"names":{"type":"array","description":"Designated name for the span (e.g. a street name or a transport name)","items":{"$ref":"#/components/schemas/LocalizedString"}},"routeNumbers":{"type":"array","description":"Designated route name or number of the span (e.g. 'M25')","items":{"$ref":"#/components/schemas/LocalizedString"}},"countryCode":{"$ref":"#/components/schemas/CountryCode"},"functionalClass":{"$ref":"#/components/schemas/FunctionalClass"},"speedLimit":{"$ref":"#/components/schemas/Speed"},"maxSpeed":{"$ref":"#/components/schemas/MaxSpeed"},"dynamicSpeedInfo":{"$ref":"#/components/schemas/DynamicSpeedInfo"},"segmentId":{"type":"string","description":"**Disclaimer: This property is currently in beta release, and is therefore subject to breaking changes.**\n\nThe directed topology segment id including prefix\n\nThe id consists of two parts.\n* The direction ('+' or '-')\n* followed by the topology segment id\n\nThe direction specifies whether the route is using the link in it''s canonical direction ('+' aka traveling along the geometry's direction), or against it ('-' aka traveling against the geometry's direction).\n"},"segmentRef":{"type":"string","description":"A reference to the HMC topology segment used in this span.\n\nThe standard representation of a segment reference has the following structure:\n{catalogHrn}:{catalogVersion}:({layerId})?:{tileId}:{segmentId}(#{direction}({startOffset}..{endOffset})?)?\n\nThe individual parts are:\n* catalogHrn: The Resource Name that identifies the source catalog of the segment\n* catalogVersion: The catalog version\n* layerId (optional): The layer inside the catalog where the segment can be found, example: topology-geometry\n* tileId: The tile key of the partition/tile where the segment is located in the given version of the catalog. This can be on a lower level than the actual segment is stored at (for example, the provided tile ID can be on level 14, despite topology-geometry partitions being tiled at level 12). The level of a tile key is indicated by the position of the highest set bit in binary representation. Since the tile key represents a morton code of the x and y portion of the Tile ID, the level 12 tile ID can be retrieved from the level 14 tile ID by removing the 4 least significant bits (or 2 bits per level) or 1 hexidecimal digit. For example, the level 14 tile 377894441 is included in the level 12 tile 23618402 (377894441<sub>10</sub> = 16863629<sub>16</sub> &rightarrow; 1686362<sub>16</sub> = 23618402<sub>10</sub>)\n* segmentId: The identifier of the referenced topology segment inside the catalog\n* direction (optional): Either '*' for undirected or bidirectional, '+' for positive direction, '-' for negative direction, or '?' for unknown direction (not used by the routing service)\n* startOffset/endOffset (optional): The start- and end offset are non-negative numbers between 0 and 1, representing the start and end of the referenced range using a proportion of the length of the segment. 0 represents the start and 1 the end of the segment, relative to the indicated direction (or positive direction in case of undirected segments). Example: 0.7..1\nThe segment references can also be provided in a compact representation, to reduce the response size. In the compact representation, some parts are replaced by placeholders, which can be resolved using the refReplacements dictionary in the parent section.\nThe placeholder format is \\$\\d+ and need to be surrounded by columns or string start/end. It can be captured with the following regular expression: (^|:)\\$\\d+(:|$)\n\nExample of the segment reference previously mentioned in compact representation:\n$0:377894441:$1:84905195#+0.7..1\nWith the corresponding refReplacements:\n"},"baseDuration":{"$ref":"#/components/schemas/Duration"},"incidents":{"type":"array","description":"A list of indices into the incident array of the parent section.\nReferences all incidents that apply to the span.\n","items":{"type":"integer"}}},"description":"Span attached to a `Section` describing pedestrian content.\n"},"PedestrianSummary":{"required":["duration","length"],"properties":{"duration":{"$ref":"#/components/schemas/Duration"},"length":{"$ref":"#/components/schemas/Distance"},"baseDuration":{"description":"Duration (in seconds) ignoring time-aware information.\n\nFor pedestrian mode, the reported time is currently equal to that in `duration`.\n","allOf":[{"$ref":"#/components/schemas/Duration"}]}},"description":"Total value of key attributes for a route section."},"PedestrianTransport":{"required":["mode"],"properties":{"mode":{"$ref":"#/components/schemas/PedestrianMode"}},"description":"Information about a transport"},"Place":{"description":"A place represents a generic location relevant for the route.","allOf":[{"$ref":"#/components/schemas/BasePlace"}]},"RangePrice":{"required":["currency","type"],"properties":{"type":{"type":"string","description":"Type of price represented by this object. The API customer is responsible for correctly visualizing\nthe pricing model. As it is possible to extend the supported price types in the future,\nthe price information should be hidden when an unknown type is encountered.\n\nAvailable price types are:\n\n  * `value` - A single value.\n  * `range` - A range value that includes a minimum and maximum price.\n"},"estimated":{"type":"boolean","description":"Attribute value is `true` if the fare price is estimated, `false` if it is an exact value.","default":false},"currency":{"type":"string","description":"Local currency of the price compliant to ISO 4217"},"unit":{"description":"When set, the price is paid for a specific duration.\n\nExamples:\n  * `\"unit\": 3600` - price for one hour\n  * `\"unit\": 28800` - price for 8 hours\n  * `\"unit\": 86400` - price for one day\n","allOf":[{"$ref":"#/components/schemas/Duration"}]},"minimum":{"type":"number","description":"Minimum price"},"maximum":{"type":"number","description":"Maximum price"}}},"RouteResponseNotice":{"required":["code"],"properties":{"title":{"type":"string","description":"Human-readable notice description.","example":"No route found"},"code":{"type":"string","description":"Extensible enum: `noRouteFound` `failedRouteHandleCreation` `cancelled` `routeCalculationFailed` `couldNotMatchOrigin` `couldNotMatchDestination` `violatedTransportModeInRouteHandleDecoding` `unknownError` `...`\nCurrently known codes (non-exhaustive: this list is going to be extended for new error situations):\n\n| Code      | Description  | Severity |\n| --------- | ------- | ------- |\n| noRouteFound | No Route was found | critical |\n| failedRouteHandleCreation | No RouteHandle was created | critical |\n| cancelled | Calculation took too long and was cancelled | critical |\n| routeCalculationFailed | Calculation did not succeed | critical |\n| couldNotMatchOrigin | Origin waypoint could not be matched | critical |\n| couldNotMatchDestination | Destination waypoint could not be matched | critical |\n| violatedTransportModeInRouteHandleDecoding | Route handle decoding failed due to forbidden segments for the specified transport mode | critical |\n| unknownError | No detailed error cause has been determined | critical |\n","example":"noRouteFound","x-extensible-enum":["noRouteFound","failedRouteHandleCreation","cancelled","routeCalculationFailed","couldNotMatchOrigin","couldNotMatchDestination","violatedTransportModeInRouteHandleDecoding","unknownError"]},"severity":{"$ref":"#/components/schemas/NoticeSeverity"},"details":{"type":"array","description":"Additional details about the notice","items":{"$ref":"#/components/schemas/BaseNoticeDetail"}}},"description":"A notice contains important notifications.","example":{"$ref":"#/components/examples/routeResponseNoticeExample"}},"SinglePrice":{"required":["currency","type","value"],"properties":{"type":{"type":"string","description":"Type of price represented by this object. The API customer is responsible for correctly visualizing\nthe pricing model. As it is possible to extend the supported price types in the future,\nthe price information should be hidden when an unknown type is encountered.\n\nAvailable price types are:\n\n  * `value` - A single value.\n  * `range` - A range value that includes a minimum and maximum price.\n"},"estimated":{"type":"boolean","description":"Attribute value is `true` if the fare price is estimated, `false` if it is an exact value.","default":false},"currency":{"type":"string","description":"Local currency of the price compliant to ISO 4217"},"unit":{"description":"When set, the price is paid for a specific duration.\n\nExamples:\n  * `\"unit\": 3600` - price for one hour\n  * `\"unit\": 28800` - price for 8 hours\n  * `\"unit\": 86400` - price for one day\n","allOf":[{"$ref":"#/components/schemas/Duration"}]},"value":{"type":"number","description":"The price value"}}},"StationPlace":{"required":["location","type"],"properties":{"name":{"type":"string","description":"Location name"},"waypoint":{"type":"integer","description":"If present, this place corresponds to the waypoint in the request with the same index."},"type":{"type":"string","description":"Place type. Each place type can have extra attributes.\n\n**NOTE:** The list of possible place types could be extended in the future.\nThe client application is expected to handle such a case gracefully.\n"},"location":{"description":"The position of this location\n\nThis position was used in route calculation. It may be different to the original position provided in the request.\n","allOf":[{"$ref":"#/components/schemas/Location"}]},"originalLocation":{"description":"If present, the original position of this location provided in the request.","allOf":[{"$ref":"#/components/schemas/Location"}]},"id":{"type":"string","description":"Identifier of this station"},"platform":{"type":"string","description":"Platform name or number for the departure."}},"description":"A station"},"TransitSpan":{"properties":{"offset":{"minimum":0,"type":"integer","description":"Offset of a coordinate in the section's polyline.\n","format":"int32"},"length":{"$ref":"#/components/schemas/Distance"},"duration":{"$ref":"#/components/schemas/Duration"},"countryCode":{"$ref":"#/components/schemas/CountryCode"},"names":{"type":"array","description":"Designated name for the span (e.g. a street name or a transport name)","items":{"$ref":"#/components/schemas/LocalizedString"}}},"description":"Contains information attached to a contiguous part of a `Section`. The information may be\nattached along different dimensions of a section which are geometry (spatial), distance or\ntime.\n\nA section, if it uses spans, has an optional attribute `spans` which is an array of\nextended `Span` types.\n\nThe attributes of a span which should be returned in the response are\nconfigured by a request parameter.\n\nUse this type as a base for any span extension for sections that provide spans.\n"},"TransitTransport":{"required":["mode"],"properties":{"mode":{"$ref":"#/components/schemas/TransitModeOutput"},"name":{"type":"string","description":"Transit line name","example":"U2"},"headsign":{"type":"string","description":"Transit line headsign"},"category":{"type":"string","description":"Human readable transport category (such as Bus, Gondola, Tram, Train, ...)"},"color":{"description":"Color of the transport polyline and background for the transport name.","allOf":[{"$ref":"#/components/schemas/Color"}]},"textColor":{"description":"Color of the transport name.","allOf":[{"$ref":"#/components/schemas/Color"}]}},"description":"Transit transport information."},"Truck":{"type":"object","properties":{"shippedHazardousGoods":{"type":"string","description":"Comma-separated list of shipped hazardous goods in the vehicle.\n\nPossible values are:\n\n* `explosive`: Explosive material\n* `gas`: Gas\n* `flammable`: Flammable material\n* `combustible`: Combustible material\n* `organic`: Organic material\n* `poison`: Poison\n* `radioactive`: Radioactive material\n* `corrosive`: Corrosive material\n* `poisonousInhalation`: Materials that are poisonous upon inhalation\n* `harmfulToWater`: Materials that are harmful to water\n* `other`: Other types of hazardous materials\n","example":"explosive,gas,flammable"},"grossWeight":{"minimum":0,"type":"integer","description":"Vehicle weight including trailers and shipped goods, in kilograms.","format":"int32"},"weightPerAxle":{"minimum":0,"type":"integer","description":"Vehicle weight per axle, in kilograms.","format":"int32"},"height":{"maximum":5000,"minimum":0,"type":"integer","description":"Vehicle height, in centimeters.","format":"int32"},"width":{"maximum":5000,"minimum":0,"type":"integer","description":"Vehicle width, in centimeters.","format":"int32"},"length":{"maximum":30000,"minimum":0,"type":"integer","description":"Vehicle length, in centimeters.","format":"int32"},"tunnelCategory":{"$ref":"#/components/schemas/TunnelCategory"},"axleCount":{"maximum":255,"minimum":2,"type":"integer","description":"Defines total number of axles in the vehicle.\n","format":"int32"},"type":{"$ref":"#/components/schemas/TruckTypeWithDefault"},"trailerCount":{"maximum":255,"minimum":0,"type":"integer","description":"Number of trailers attached to the vehicle.","format":"int32","default":0}},"description":"Truck specific parameters"},"VehicleNoticeDetail":{"description":"Details attached to notices in vehicle section.","discriminator":{"propertyName":"type","mapping":{"restriction":"#/components/schemas/VehicleRestriction"}},"oneOf":[{"$ref":"#/components/schemas/VehicleRestriction"}]},"VehicleSpan":{"properties":{"offset":{"minimum":0,"type":"integer","description":"Offset of a coordinate in the section's polyline.\n","format":"int32"},"length":{"$ref":"#/components/schemas/Distance"},"duration":{"$ref":"#/components/schemas/Duration"},"streetAttributes":{"type":"array","description":"`StreetAttributes` is applied to a span of a route section and describes attribute flags of a street.\n* `rightDrivingSide`: Vehicles have to drive on the right-hand side of the road.\n* `dirtRoad`: This part of the route has an un-paved surface.\n* `tunnel`: This part of the route is a tunnel.\n* `bridge`: This part of the route is a bridge.\n* `ramp`: This part of the route is a ramp (usually connecting to/from/between highways).\n* `motorway`: This part of the route is a controlled access road (usually highways).\n* `roundabout`: This part of the route is a roundabout.\n* `underConstruction`: This part of the route is under construction.\n* `dividedRoad`: This part of the route uses a road with a physical or legal divider in the middle.\n* `privateRoad`: This part of the route uses a privately owned road.\n\nAs it is possible that new street attributes are supported in the future, unknown street attributes should be ignored.\n","items":{"$ref":"#/components/schemas/StreetAttributes"}},"walkAttributes":{"type":"array","description":"Accessibility and walk-related attribute flags.\n\n* `stairs`: This part of the route is a staircase.\n* `park`: This part of the route is in a park.\n* `indoor`: This part of the route is inside a venue.\n* `open`:  Describes whether this part of the route can be traversed.\n* `noThrough`:  A part of the route you can only enter if your destination is located there.\n* `tollRoad`: Access to this part of the route is restricted with a fee (or toll).\n\nAs it is possible that new attributes are supported in the future, unknown attributes should be ignored.\n","items":{"$ref":"#/components/schemas/WalkAttributes"}},"carAttributes":{"type":"array","description":"Car specific `AccessAttributes`.\n\n`AccessAttributes` is applied to a span of a route section and describes access flags of a street.\n* `open`:  This part of the route is open to cars.\n* `noThrough`:  This part of the route can only be entered if the destination is located there.\n* `tollRoad`: This part of the route is restricted with a fee (or toll).\n\nAs it is possible that new access attributes are supported in the future, unknown access attributes should be ignored.\n","items":{"$ref":"#/components/schemas/AccessAttributes"}},"truckAttributes":{"type":"array","description":"Truck specific `AccessAttributes`.\n\n`AccessAttributes` is applied to a span of a route section and describes access flags of a street.\n* `open`:  This part of the route is open to trucks.\n* `noThrough`:  This part of the route can only be entered if the destination is located there.\n* `tollRoad`: This part of the route is restricted with a fee (or toll).\n\nAs it is possible that new access attributes are supported in the future, unknown access attributes should be ignored.\n","items":{"$ref":"#/components/schemas/AccessAttributes"}},"scooterAttributes":{"type":"array","description":"Scooter specific `AccessAttributes`.\n\n`AccessAttributes` is applied to a span of a route section and describes access flags of a street.\n* `open`:  This part of the route is open to scooters.\n\nAs it is possible that new access attributes are supported in the future, unknown access attributes should be ignored.\n","items":{"$ref":"#/components/schemas/AccessAttributes"}},"names":{"type":"array","description":"Designated name for the span (e.g. a street name or a transport name)","items":{"$ref":"#/components/schemas/LocalizedString"}},"routeNumbers":{"type":"array","description":"Designated route name or number of the span (e.g. 'M25')","items":{"$ref":"#/components/schemas/LocalizedString"}},"countryCode":{"$ref":"#/components/schemas/CountryCode"},"functionalClass":{"$ref":"#/components/schemas/FunctionalClass"},"speedLimit":{"$ref":"#/components/schemas/Speed"},"maxSpeed":{"$ref":"#/components/schemas/MaxSpeed"},"dynamicSpeedInfo":{"$ref":"#/components/schemas/DynamicSpeedInfo"},"segmentId":{"type":"string","description":"**Disclaimer: This property is currently in beta release, and is therefore subject to breaking changes.**\n\nThe id consists of two parts.\n* The direction ('+' or '-')\n* followed by the topology segment id \n\nThe direction specifies whether the route is using the link in it''s canonical direction ('+' aka traveling along the geometry's direction), or against it ('-' aka traveling against the geometry's direction).\n"},"segmentRef":{"type":"string","description":"A reference to the HMC topology segment used in this span.\n\nThe standard representation of a segment reference has the following structure:\n{catalogHrn}:{catalogVersion}:({layerId})?:{tileId}:{segmentId}(#{direction}({startOffset}..{endOffset})?)?\n\nThe individual parts are:\n* catalogHrn: The Resource Name that identifies the source catalog of the segment\n* catalogVersion: The catalog version\n* layerId (optional): The layer inside the catalog where the segment can be found, example: topology-geometry\n* tileId: The tile key of the partition/tile where the segment is located in the given version of the catalog. This can be on a lower level than the actual segment is stored at (for example, the provided tile ID can be on level 14, despite topology-geometry partitions being tiled at level 12). The level of a tile key is indicated by the position of the highest set bit in binary representation. Since the tile key represents a morton code of the x and y portion of the Tile ID, the level 12 tile ID can be retrieved from the level 14 tile ID by removing the 4 least significant bits (or 2 bits per level) or 1 hexidecimal digit. For example, the level 14 tile 377894441 is included in the level 12 tile 23618402 (377894441<sub>10</sub> = 16863629<sub>16</sub> &rightarrow; 1686362<sub>16</sub> = 23618402<sub>10</sub>)\n* segmentId: The identifier of the referenced topology segment inside the catalog\n* direction (optional): Either '*' for undirected or bidirectional, '+' for positive direction, '-' for negative direction, or '?' for unknown direction (not used by the routing service)\n* startOffset/endOffset (optional): The start- and end offset are non-negative numbers between 0 and 1, representing the start and end of the referenced range using a proportion of the length of the segment. 0 represents the start and 1 the end of the segment, relative to the indicated direction (or positive direction in case of undirected segments). Example: 0.7..1\n\nExample of a segment reference in standard representation:\nThe segment references can also be provided in a compact representation, to reduce the response size. In the compact representation, some parts are replaced by placeholders, which can be resolved using the refReplacements dictionary in the parent section.\nThe placeholder format is \\$\\d+ and need to be surrounded by columns or string start/end. It can be captured with the following regular expression: (^|:)\\$\\d+(:|$)\n\nExample of the segment reference previously mentioned in compact representation:\n$0:377894441:$1:84905195#+0.7..1\n"},"consumption":{"$ref":"#/components/schemas/Energy"},"baseDuration":{"$ref":"#/components/schemas/Duration"},"incidents":{"type":"array","description":"A list of indices into the incident array of the parent section.\nReferences all incidents that apply to the span.\n","items":{"type":"integer"}},"routingZones":{"type":"array","description":"A list of indices into the routing zone array of the parent section.\nReferences all applicable routing zones to the span.\n","items":{"type":"integer"}},"notices":{"type":"array","description":"A list of indices into the notices array of the parent section.\nReferences all notices that apply to the span.\n","items":{"type":"integer"}}},"description":"Span attached to a `Section` describing vehicle content.\n"},"VehicleSummary":{"required":["duration","length"],"properties":{"duration":{"$ref":"#/components/schemas/Duration"},"length":{"$ref":"#/components/schemas/Distance"},"consumption":{"$ref":"#/components/schemas/Energy"},"baseDuration":{"description":"Duration (in seconds) ignoring time-aware information.\n\nIn particular, dynamic traffic information is not taken into account. Only\nfree-flow speeds based on historical traffic are used to calculate this duration.\n\nThe `baseDuration` can also be understood as the best possible duration.\n","allOf":[{"$ref":"#/components/schemas/Duration"}]}},"description":"Total value of key attributes for a route section."},"VehicleTransport":{"required":["mode"],"properties":{"mode":{"$ref":"#/components/schemas/VehicleMode"}},"description":"Information about a transport"},"VehicleTravelSummary":{"required":["duration","length"],"properties":{"duration":{"$ref":"#/components/schemas/Duration"},"length":{"$ref":"#/components/schemas/Distance"},"consumption":{"description":"Estimated net energy consumption (in kWh) for the travel only.\nDoes not include any charging at stations.\n","allOf":[{"$ref":"#/components/schemas/Energy"}]},"baseDuration":{"description":"Duration (in seconds) ignoring time-aware information.\n\nIn particular, dynamic traffic information is not taken into account. Only\nfree-flow speeds based on historical traffic are used to calculate this duration.\n\nThe `baseDuration` can also be understood as the best possible duration.\n","allOf":[{"$ref":"#/components/schemas/Duration"}]},"mlDuration":{"description":"Duration (in seconds) based on the region-specific machine learning model.\n\n`mlDuration` is calculated for each route section of the route.\nIf a section of the route is not supported, `mlDuration` is not present in the summary of that section and a notice with the reason is provided.\n`mlDuration` is only calculated for the entire section. The sum of span durations is not equivalent to `mlDuration`.\n","allOf":[{"$ref":"#/components/schemas/Duration"}]}},"description":"Total value of key attributes for a route section."},"ArriveAction":{"allOf":[{"$ref":"#/components/schemas/OffsetAction"}]},"ContinueAction":{"allOf":[{"$ref":"#/components/schemas/OffsetAction"}]},"DepartAction":{"allOf":[{"$ref":"#/components/schemas/OffsetAction"}]},"FarePrice":{"description":"Price of a fare","discriminator":{"propertyName":"type","mapping":{"value":"#/components/schemas/SinglePrice","range":"#/components/schemas/RangePrice"}},"oneOf":[{"$ref":"#/components/schemas/SinglePrice"},{"$ref":"#/components/schemas/RangePrice"}]},"Passthrough":{"required":["place"],"properties":{"place":{"$ref":"#/components/schemas/Place"},"offset":{"type":"number","description":"Passthrough offsets are the coordinate index in the polyline."}},"description":"Describes a location and time the section is passing through."},"PedestrianPostAction":{"discriminator":{"propertyName":"action","mapping":{"wait":"#/components/schemas/OffsetAction"}},"oneOf":[{"$ref":"#/components/schemas/OffsetAction"}]},"TimeRestrictedPrice":{"required":["currency","type","value"],"properties":{"type":{"type":"string","description":"Type of price represented by this object. The API customer is responsible for correctly visualizing\nthe pricing model. As it is possible to extend the supported price types in the future,\nthe price information should be hidden when an unknown type is encountered.\n\nAvailable price types are:\n\n  * `restricted` - A single price value valid for a specific time or duration\n"},"estimated":{"type":"boolean","description":"Attribute value is `true` if the fare price is estimated, `false` if it is an exact value.","default":false},"currency":{"type":"string","description":"Local currency of the price compliant to ISO 4217"},"unit":{"description":"When set, the price is paid for a specific duration.\n\nExamples:\n  * `\"unit\": 3600` - price for one hour\n  * `\"unit\": 28800` - price for 8 hours\n  * `\"unit\": 86400` - price for one day\n","allOf":[{"$ref":"#/components/schemas/Duration"}]},"value":{"type":"number","description":"The price value"},"days":{"type":"array","description":"This price applies only for the selected days","example":["sa","su"],"items":{"$ref":"#/components/schemas/TimeRestictedWeekdays"}},"minDuration":{"description":"The price applies if the duration is more or equal to `minDuration`","example":1801,"allOf":[{"$ref":"#/components/schemas/Duration"}]},"maxDuration":{"description":"The price applies if the duration is less or equal to `maxDuration`","example":3600,"allOf":[{"$ref":"#/components/schemas/Duration"}]},"fromTime":{"description":"The price applies from this time of the day","example":30600,"allOf":[{"$ref":"#/components/schemas/PartialTime"}]},"toTime":{"description":"The price applies untill this time of the day","example":73800,"allOf":[{"$ref":"#/components/schemas/PartialTime"}]}}},"TransitDeparture":{"required":["place"],"properties":{"time":{"description":"Expected time of departure of the event. Format is **RFC 3339**, section 5.6 as defined by `date-time`.","allOf":[{"$ref":"#/components/schemas/Time"}]},"place":{"description":"Departure/arrival location","allOf":[{"$ref":"#/components/schemas/StationPlace"}]},"delay":{"description":"The accumulated delay in seconds from the scheduled time of the event.","allOf":[{"$ref":"#/components/schemas/DepartureDelay"}]},"status":{"$ref":"#/components/schemas/DepartureStatus"}},"description":"Transit departure"},"TransitPostAction":{"discriminator":{"propertyName":"action","mapping":{"deboard":"#/components/schemas/DeboardAction"}},"oneOf":[{"$ref":"#/components/schemas/DeboardAction"}]},"TransitPreAction":{"description":"An action that must be done prior to `departure`.","discriminator":{"propertyName":"action","mapping":{"board":"#/components/schemas/BoardAction"}},"oneOf":[{"$ref":"#/components/schemas/BoardAction"}]},"TurnAction":{"required":["action","duration"],"properties":{"action":{"type":"string","description":"The type of the action.\n\n**NOTE:** The list of possible actions may be extended in the future. The client application should handle such a case gracefully.\n"},"duration":{"description":"Estimated duration of this action (in seconds). Actions last until the next action, or the end of the route in case of the last one.","allOf":[{"$ref":"#/components/schemas/Duration"}]},"instruction":{"type":"string","description":"Description of the action (e.g. Turn left onto Minna St.)."},"offset":{"type":"integer","description":"Offset of a coordinate in the section's polyline."},"length":{"description":"Estimated length of this action (in meters). Actions extend until the next action, or the end of the route in case of the last one.","allOf":[{"$ref":"#/components/schemas/Distance"}]},"currentRoad":{"description":"Attributes of the current road","allOf":[{"$ref":"#/components/schemas/RoadInfo"}]},"nextRoad":{"description":"Attributes of the next road","allOf":[{"$ref":"#/components/schemas/RoadInfo"}]},"exitSign":{"description":"Attributes of the road exit","allOf":[{"$ref":"#/components/schemas/ExitInfo"}]},"direction":{"$ref":"#/components/schemas/TurnActionDirection"},"severity":{"$ref":"#/components/schemas/TurnActionSeverity"}},"description":"An action in which a direction change is made.\n\n* `ramp`: ramp maneuver, such as \"Take the left ramp onto\"\n* `roundaboutPass`: Going straight on a roundabout maneuver\n* `roundaboutEnter`: Arriving at a destination roundabout maneuver\n* `uTurn`: u-turn maneuver, such as \"Make a right U-turn at\"\n* `turn`: turn maneuver, such as \"Make a sharp right turn at\"\n* `keep`: a maneuver following a fork, such as \"Take the middle fork onto\"\n* `enterHighway`: a maneuver to enter a highway, used for turn-by-turn guidance only\n"},"VehicleNotice":{"required":["code"],"properties":{"title":{"type":"string","description":"Human-readable notice description.","example":"No route found"},"code":{"type":"string","description":"Extensible enum: `violatedAvoidControlledAccessHighway` `violatedAvoidTollRoad` `violatedAvoidFerry` `violatedAvoidTunnel` `violatedAvoidDirtRoad` `violatedAvoidRailFerry` `violatedAvoidPark` `violatedBlockedRoad` `violatedStartDirection` `violatedCarpool` `violatedTurnRestriction` `violatedVehicleRestriction` `violatedZoneRestriction` `violatedAvoidDifficultTurns` `mlDurationUnavailable` `simplePolyline` `...`\nCurrently known codes (non-exhaustive: this list is going to be extended for new situations):\n\n| Code      | Description  | Severity |\n| --------- | ------- | ------- |\n| violatedAvoidControlledAccessHighway | Route did not manage to avoid user preference | critical |\n| violatedAvoidTollRoad | Route did not manage to avoid user preference | critical |\n| violatedAvoidFerry | Route did not manage to avoid user preference | critical |\n| violatedAvoidTunnel | Route did not manage to avoid user preference | critical |\n| violatedAvoidDirtRoad | Route did not manage to avoid user preference | critical |\n| violatedAvoidRailFerry | Route did not manage to avoid user preference | critical |\n| violatedAvoidPark | Route did not manage to avoid user preference | critical |\n| violatedBlockedRoad | Route uses roads blocked by traffic events | critical |\n| violatedStartDirection | Start direction of the route is not as requested | critical |\n| violatedCarpool | Route did not manage to avoid user preference | critical |\n| violatedTurnRestriction | Route uses a time-restricted turn | critical |\n| violatedVehicleRestriction | Route uses a road which is forbidden for the given vehicle profile | critical |\n| violatedZoneRestriction | Route uses a road which is part of restricted routing zones | critical |\n| violatedAvoidDifficultTurns | Route did not manage to avoid user preference | critical |\n| violatedEmergencyGate | Route goes through an emergency gate | critical |\n| mlDurationUnavailable | Machine learning duration was requested but is not available for this section | info |\n| simplePolyline | An accurate polyline is not available for this section. The returned polyline has been generated from departure and arrival places. | info |\n","example":"noRouteFound","x-extensible-enum":["violatedAvoidControlledAccessHighway","violatedAvoidTollRoad","violatedAvoidFerry","violatedAvoidTunnel","violatedAvoidDirtRoad","violatedAvoidRailFerry","violatedAvoidPark","violatedBlockedRoad","violatedStartDirection","violatedCarpool","violatedTurnRestriction","violatedVehicleRestriction","violatedZoneRestriction","violatedAvoidDifficultTurns","violatedEmergencyGate","mlDurationUnavailable","simplePolyline"]},"severity":{"$ref":"#/components/schemas/NoticeSeverity"},"details":{"type":"array","description":"Additional details about the notice","items":{"$ref":"#/components/schemas/VehicleNoticeDetail"}}},"description":"A notice contains important notifications.","example":{"$ref":"#/components/examples/noticeWithRestrictionsExample"}},"VehiclePostAction":{"description":"Action attached to a vehicle section that must be done after `arrival`.","discriminator":{"propertyName":"action","mapping":{"chargingSetup":"#/components/schemas/ChargingSetupAction","charging":"#/components/schemas/ChargingAction","wait":"#/components/schemas/OffsetAction"}},"oneOf":[{"$ref":"#/components/schemas/ChargingSetupAction"},{"$ref":"#/components/schemas/ChargingAction"},{"$ref":"#/components/schemas/OffsetAction"}]},"ExitAction":{"required":["action","duration"],"properties":{"action":{"type":"string","description":"The type of the action.\n\n**NOTE:** The list of possible actions may be extended in the future. The client application should handle such a case gracefully.\n"},"duration":{"description":"Estimated duration of this action (in seconds). Actions last until the next action, or the end of the route in case of the last one.","allOf":[{"$ref":"#/components/schemas/Duration"}]},"instruction":{"type":"string","description":"Description of the action (e.g. Turn left onto Minna St.)."},"offset":{"type":"integer","description":"Offset of a coordinate in the section's polyline."},"length":{"description":"Estimated length of this action (in meters). Actions extend until the next action, or the end of the route in case of the last one.","allOf":[{"$ref":"#/components/schemas/Distance"}]},"currentRoad":{"description":"Attributes of the current road","allOf":[{"$ref":"#/components/schemas/RoadInfo"}]},"nextRoad":{"description":"Attributes of the next road","allOf":[{"$ref":"#/components/schemas/RoadInfo"}]},"exitSign":{"description":"Attributes of the road exit","allOf":[{"$ref":"#/components/schemas/ExitInfo"}]},"direction":{"$ref":"#/components/schemas/TurnActionDirection"},"severity":{"$ref":"#/components/schemas/TurnActionSeverity"},"exit":{"maximum":12,"minimum":1,"type":"integer","description":"Which exit to take next.","default":1}},"description":"An action to leave a roundabout or highway.\n\n* `exit`: exit maneuver, such as \"Take the left exit to\"\n* `roundaboutExit`: roundabout exit maneuver, such as \"Take the third exit of the roundabout onto\"\n"},"Fare":{"required":["id","name","price"],"properties":{"id":{"type":"string","description":"Unique Fare id. Used to deduplicate fares that apply to multiple sections"},"name":{"type":"string","description":"Name of a fare"},"price":{"$ref":"#/components/schemas/FarePrice"},"reason":{"allOf":[{"$ref":"#/components/schemas/FareReason"}]}},"description":"`Fare` type contains information about a single fare or ticket needed for this section of the route."},"KeepAction":{"allOf":[{"$ref":"#/components/schemas/TurnAction"}]},"ParkingLotPlace":{"required":["location","type"],"properties":{"name":{"type":"string","description":"Location name"},"waypoint":{"type":"integer","description":"If present, this place corresponds to the waypoint in the request with the same index."},"type":{"type":"string","description":"Place type. Each place type can have extra attributes.\n\n**NOTE:** The list of possible place types could be extended in the future.\nThe client application is expected to handle such a case gracefully.\n"},"location":{"description":"The position of this location\n\nThis position was used in route calculation. It may be different to the original position provided in the request.\n","allOf":[{"$ref":"#/components/schemas/Location"}]},"originalLocation":{"description":"If present, the original position of this location provided in the request.","allOf":[{"$ref":"#/components/schemas/Location"}]},"id":{"type":"string","description":"Identifier of this parking lot"},"attributes":{"type":"array","description":"Attributes of a parking lot.\n\n* `parkAndRide` - this parking lot is of type \"Park and Ride\",\n  such as it is a parking specifically designed to allow transition between car and transit.\n","items":{"$ref":"#/components/schemas/ParkingLotPlaceType"}},"rates":{"type":"array","description":"List of possible parking rates for this facility. Different rates can apply depending on the day, time of the day or parking duration.\n","items":{"$ref":"#/components/schemas/TimeRestrictedPrice"}}},"description":"A parking lot"},"RampAction":{"allOf":[{"$ref":"#/components/schemas/TurnAction"}]},"RoundaboutEnterAction":{"allOf":[{"$ref":"#/components/schemas/TurnAction"}]},"RoundaboutPassAction":{"allOf":[{"$ref":"#/components/schemas/TurnAction"}]},"TransitStop":{"required":["departure"],"properties":{"departure":{"$ref":"#/components/schemas/TransitDeparture"},"duration":{"type":"integer","description":"Stop duration. If not set the vehicle departs as soon as people are on board.","default":0}},"description":"A transit stop of the route"},"UTurnAction":{"allOf":[{"$ref":"#/components/schemas/TurnAction"}]},"PedestrianPlace":{"description":"Place used in pedestrian routing","discriminator":{"propertyName":"type","mapping":{"place":"#/components/schemas/Place","station":"#/components/schemas/StationPlace","accessPoint":"#/components/schemas/AccessPointPlace","parkingLot":"#/components/schemas/ParkingLotPlace","chargingStation":"#/components/schemas/ChargingStationPlace"}},"oneOf":[{"$ref":"#/components/schemas/Place"},{"$ref":"#/components/schemas/StationPlace"},{"$ref":"#/components/schemas/AccessPointPlace"},{"$ref":"#/components/schemas/ParkingLotPlace"},{"$ref":"#/components/schemas/ChargingStationPlace"}]},"RoundaboutExitAction":{"allOf":[{"$ref":"#/components/schemas/ExitAction"}]},"TransitSection":{"required":["arrival","departure","id","type"],"properties":{"id":{"type":"string","description":"Unique identifier of the section"},"type":{"type":"string","description":"Section type used by the client to identify what extension to the BaseSection are available."},"preActions":{"type":"array","description":"Actions that must be done prior to `departure`.","items":{"$ref":"#/components/schemas/TransitPreAction"}},"actions":{"type":"array","description":"Actions that must be done during the travel portion of the section, i.e., between `departure` and `arrival`.","items":{"$ref":"#/components/schemas/OffsetAction"}},"language":{"type":"string","description":"Language of the localized strings in the section, if any, in BCP47 format."},"postActions":{"type":"array","description":"Actions that must be done after `arrival`.","items":{"$ref":"#/components/schemas/TransitPostAction"}},"turnByTurnActions":{"type":"array","description":"Actions for turn by turn guidance during the travel portion of the section, i.e., between `departure` and `arrival`.","items":{"$ref":"#/components/schemas/OffsetAction"}},"departure":{"$ref":"#/components/schemas/TransitDeparture"},"arrival":{"$ref":"#/components/schemas/TransitDeparture"},"passthrough":{"type":"array","description":"List of via waypoints this section is passing through.\n\nEach via waypoint of the request that is a `passThrough=true` waypoint, appears as a\n`Passthrough` in the response. It appears in the section that starts with the closest\nnon-passthrough via specified before it or origin.\n\nThe passthrough vias appear in this list in the order they are traversed. They are\ntraversed in the order they are specified in the request.\n","items":{"$ref":"#/components/schemas/Passthrough"}},"summary":{"description":"Total value of key attributes (e.g., duration, length) summed up for the entire section, including `preActions`, `postActions`,\nand the travel portion of the section.\n","allOf":[{"$ref":"#/components/schemas/BaseSummary"}]},"travelSummary":{"description":"Total value of key attributes (e.g., duration, length) summed up for just the travel portion of the section,\nbetween `departure` and `arrival`. `preActions` and `postActions` are excluded.\n","allOf":[{"$ref":"#/components/schemas/BaseSummary"}]},"polyline":{"$ref":"#/components/schemas/Polyline"},"notices":{"type":"array","description":"Contains a list of issues related to this section of the route.\n\nFollows a list of possible notice codes:\n\n* `noSchedule`: A timetable schedule is not available for the transit line in this section,\n  and only the run frequency is available. As a result, departure/arrival times are approximated.\n* `noIntermediate`: Information about intermediate stops is not available for this transit line.\n* `unwantedMode`: This section contains a transport mode that was explictly disabled.\n  Mode filtering is not available in this area.\n* `scheduledTimes`: The times returned on this section are the scheduled times even though delay information are available.\n* `simplePolyline`: An accurate polyline is not available for this transit line.\nThe returned polyline connects consecutive stops of a route with straight lines.\n","items":{"$ref":"#/components/schemas/Notice"}},"transport":{"$ref":"#/components/schemas/TransitTransport"},"intermediateStops":{"type":"array","description":"Intermediate stops between departure and destination of the transit line. It can be missing if this information is not available or not requested.\n","items":{"$ref":"#/components/schemas/TransitStop"}},"agency":{"$ref":"#/components/schemas/Agency"},"attributions":{"type":"array","description":"List of required attributions to display.","items":{"$ref":"#/components/schemas/Attribution"}},"fares":{"type":"array","description":"List of tickets to pay for this section of the route","items":{"$ref":"#/components/schemas/Fare"}},"spans":{"type":"array","description":"Span attached to a `Section` describing transit content.\n","items":{"$ref":"#/components/schemas/TransitSpan"}},"incidents":{"type":"array","description":"A list of all incidents that apply to the section.","items":{"$ref":"#/components/schemas/TransitIncident"}}},"description":"A section of the route. It contains departure, arrival, and route information."},"VehiclePlace":{"description":"Place used in vehicle routing.","discriminator":{"propertyName":"type","mapping":{"place":"#/components/schemas/Place","station":"#/components/schemas/StationPlace","accessPoint":"#/components/schemas/AccessPointPlace","parkingLot":"#/components/schemas/ParkingLotPlace","chargingStation":"#/components/schemas/ChargingStationPlace"}},"oneOf":[{"$ref":"#/components/schemas/Place"},{"$ref":"#/components/schemas/StationPlace"},{"$ref":"#/components/schemas/AccessPointPlace"},{"$ref":"#/components/schemas/ParkingLotPlace"},{"$ref":"#/components/schemas/ChargingStationPlace"}]},"PedestrianAction":{"description":"Action attached to a pedestrian section.","discriminator":{"propertyName":"action","mapping":{"depart":"#/components/schemas/DepartAction","arrive":"#/components/schemas/ArriveAction","continue":"#/components/schemas/ContinueAction","ramp":"#/components/schemas/RampAction","exit":"#/components/schemas/ExitAction","roundaboutPass":"#/components/schemas/RoundaboutPassAction","roundaboutEnter":"#/components/schemas/RoundaboutEnterAction","roundaboutExit":"#/components/schemas/RoundaboutExitAction","uTurn":"#/components/schemas/UTurnAction","turn":"#/components/schemas/TurnAction","keep":"#/components/schemas/KeepAction"}},"oneOf":[{"$ref":"#/components/schemas/DepartAction"},{"$ref":"#/components/schemas/ArriveAction"},{"$ref":"#/components/schemas/ContinueAction"},{"$ref":"#/components/schemas/RampAction"},{"$ref":"#/components/schemas/ExitAction"},{"$ref":"#/components/schemas/RoundaboutPassAction"},{"$ref":"#/components/schemas/RoundaboutEnterAction"},{"$ref":"#/components/schemas/RoundaboutExitAction"},{"$ref":"#/components/schemas/UTurnAction"},{"$ref":"#/components/schemas/TurnAction"},{"$ref":"#/components/schemas/KeepAction"}]},"PedestrianDeparture":{"required":["place"],"properties":{"time":{"description":"Expected time of departure of the event. Format is **RFC 3339**, section 5.6 as defined by `date-time`.","allOf":[{"$ref":"#/components/schemas/Time"}]},"place":{"$ref":"#/components/schemas/PedestrianPlace"}},"description":"Departure of pedestrian"},"VehicleAction":{"description":"Action attached to a vehicle section.","discriminator":{"propertyName":"action","mapping":{"depart":"#/components/schemas/DepartAction","arrive":"#/components/schemas/ArriveAction","continue":"#/components/schemas/ContinueAction","ramp":"#/components/schemas/RampAction","exit":"#/components/schemas/ExitAction","roundaboutPass":"#/components/schemas/RoundaboutPassAction","roundaboutEnter":"#/components/schemas/RoundaboutEnterAction","roundaboutExit":"#/components/schemas/RoundaboutExitAction","uTurn":"#/components/schemas/UTurnAction","turn":"#/components/schemas/TurnAction","keep":"#/components/schemas/KeepAction"}},"oneOf":[{"$ref":"#/components/schemas/DepartAction"},{"$ref":"#/components/schemas/ArriveAction"},{"$ref":"#/components/schemas/ContinueAction"},{"$ref":"#/components/schemas/RampAction"},{"$ref":"#/components/schemas/ExitAction"},{"$ref":"#/components/schemas/RoundaboutPassAction"},{"$ref":"#/components/schemas/RoundaboutEnterAction"},{"$ref":"#/components/schemas/RoundaboutExitAction"},{"$ref":"#/components/schemas/UTurnAction"},{"$ref":"#/components/schemas/TurnAction"},{"$ref":"#/components/schemas/KeepAction"}]},"VehicleDeparture":{"required":["place"],"properties":{"time":{"description":"Expected time of departure of the event. Format is **RFC 3339**, section 5.6 as defined by `date-time`.","allOf":[{"$ref":"#/components/schemas/Time"}]},"place":{"$ref":"#/components/schemas/VehiclePlace"},"charge":{"type":"number","description":"Vehicle battery charge (in kWh)."}},"description":"Describe a departure or arrival location and time."},"PedestrianSection":{"required":["arrival","departure","id","transport","type"],"properties":{"id":{"type":"string","description":"Unique identifier of the section"},"type":{"type":"string","description":"Section type used by the client to identify what extension to the BaseSection are available."},"preActions":{"type":"array","description":"Actions that must be done prior to `departure`.","items":{"$ref":"#/components/schemas/BaseAction"}},"actions":{"type":"array","description":"Actions to be performed at or during a specific portion of a section.\n\nAction offsets are the coordinate index in the polyline.\n","items":{"$ref":"#/components/schemas/PedestrianAction"}},"language":{"type":"string","description":"Language of the localized strings in the section, if any, in BCP47 format."},"postActions":{"type":"array","description":"Actions that must be done after `arrival`.","items":{"$ref":"#/components/schemas/PedestrianPostAction"}},"turnByTurnActions":{"type":"array","description":"Actions for turn by turn guidance during the travel portion of the section, i.e., between `departure` and `arrival`.","items":{"$ref":"#/components/schemas/OffsetAction"}},"departure":{"$ref":"#/components/schemas/PedestrianDeparture"},"arrival":{"$ref":"#/components/schemas/PedestrianDeparture"},"passthrough":{"type":"array","description":"List of via waypoints this section is passing through.\n\nEach via waypoint of the request that is a `passThrough=true` waypoint, appears as a\n`Passthrough` in the response. It appears in the section that starts with the closest\nnon-passthrough via specified before it or origin.\n\nThe passthrough vias appear in this list in the order they are traversed. They are\ntraversed in the order they are specified in the request.\n","items":{"$ref":"#/components/schemas/Passthrough"}},"summary":{"description":"Total value of key attributes (e.g. duration, length) summed up for the entire section, including `preActions`, `postActions`,\nand the travel portion of the section.\n","allOf":[{"$ref":"#/components/schemas/PedestrianSummary"}]},"travelSummary":{"description":"Total value of key attributes (e.g., duration, length) summed up for just the travel portion of the section,\nbetween `departure` and `arrival`. `preActions` and `postActions` are excluded.\n","allOf":[{"$ref":"#/components/schemas/BaseSummary"}]},"polyline":{"$ref":"#/components/schemas/Polyline"},"notices":{"type":"array","description":"Contains a list of issues related to this section of the route.\n\nFollows a list of possible notice codes:\n\n* `simplePolyline`: An accurate polyline is not available for this section.\n  The returned polyline has been generated from departure and arrival places.\n","items":{"$ref":"#/components/schemas/Notice"}},"transport":{"$ref":"#/components/schemas/PedestrianTransport"},"spans":{"type":"array","description":"Spans attached to a `Section` describing pedestrian content.\n","items":{"$ref":"#/components/schemas/PedestrianSpan"}}},"description":"Represent a section of a route"},"VehicleSection":{"required":["arrival","departure","id","transport","type"],"properties":{"id":{"type":"string","description":"Unique identifier of the section"},"type":{"type":"string","description":"Section type used by the client to identify what extension to the BaseSection are available."},"preActions":{"type":"array","description":"Actions that must be done prior to `departure`.","items":{"$ref":"#/components/schemas/BaseAction"}},"actions":{"type":"array","description":"Actions to be performed at or during a specific portion of a section.\n\nAction offsets are the coordinate index in the polyline.\n","items":{"$ref":"#/components/schemas/VehicleAction"}},"language":{"type":"string","description":"Language of the localized strings in the section, if any, in BCP47 format."},"postActions":{"type":"array","description":"Actions that must be done after `arrival`.","items":{"$ref":"#/components/schemas/VehiclePostAction"}},"turnByTurnActions":{"type":"array","description":"Actions for turn by turn guidance.\n\nAction offsets are the coordinate index in the polyline.\n","items":{"$ref":"#/components/schemas/VehicleAction"}},"departure":{"$ref":"#/components/schemas/VehicleDeparture"},"arrival":{"$ref":"#/components/schemas/VehicleDeparture"},"passthrough":{"type":"array","description":"List of via waypoints this section is passing through.\n\nEach via waypoint of the request that is a `passThrough=true` waypoint, appears as a\n`Passthrough` in the response. It appears in the section that starts with the closest\nnon-passthrough via specified before it or origin.\n\nThe passthrough vias appear in this list in the order they are traversed. They are\ntraversed in the order they are specified in the request.\n","items":{"$ref":"#/components/schemas/Passthrough"}},"summary":{"description":"Total value of key attributes (e.g., duration, length, consumption) summed up for the entire section, including `preActions`, `postActions`,\nand the travel portion of the section.\n","allOf":[{"$ref":"#/components/schemas/VehicleSummary"}]},"travelSummary":{"description":"Total value of key attributes (e.g., duration, length, consumption) summed up for just the travel portion of the section,\nbetween `departure` and `arrival`. `preActions` and `postActions` are excluded.\n","allOf":[{"$ref":"#/components/schemas/VehicleTravelSummary"}]},"routingZones":{"type":"array","description":"A list of routing zones that are applicable to the section.\n\nElements of this list will be referenced by indices within the `span` attribute of the section.\n","items":{"$ref":"#/components/schemas/RoutingZone"}},"polyline":{"$ref":"#/components/schemas/Polyline"},"notices":{"type":"array","description":"Contains a list of issues related to this section of the route.\nNotices must be carefully evaluated and the route section should be discarded\nif appropriate.\nIn particular, be aware that new notice codes may be added. If an unrecognized\nnotice code appears with a `critical` severity level, the route section must be discarded.\nPlease refer to the `code` attribute for possible values.\n","items":{"$ref":"#/components/schemas/VehicleNotice"}},"spans":{"type":"array","description":"Spans attached to a `Section` describing vehicle content.\n","items":{"$ref":"#/components/schemas/VehicleSpan"}},"incidents":{"type":"array","description":"A list of all incidents that apply to the section.","items":{"$ref":"#/components/schemas/TrafficIncident"}},"refReplacements":{"type":"object","additionalProperties":{"type":"string"},"description":"Dictionary of placeholders to replacement strings for the compact representation of map entity references.\n"},"transport":{"$ref":"#/components/schemas/VehicleTransport"}},"description":"Represent a section of a route"},"RouterSection":{"description":"One of the possible sections that can be part of the Router route.\n\n`TransitSection` is only used for ferries and car shuttles.\n","discriminator":{"propertyName":"type","mapping":{"pedestrian":"#/components/schemas/PedestrianSection","vehicle":"#/components/schemas/VehicleSection","transit":"#/components/schemas/TransitSection"}},"oneOf":[{"$ref":"#/components/schemas/PedestrianSection"},{"$ref":"#/components/schemas/VehicleSection"},{"$ref":"#/components/schemas/TransitSection"}]},"RouterRoute":{"required":["id","sections"],"properties":{"id":{"type":"string","description":"Unique identifier of the route"},"notices":{"type":"array","description":"Contains a list of issues encountered during the processing of this response.","items":{"$ref":"#/components/schemas/Notice"}},"sections":{"type":"array","description":"An ordered list of vehicle, transit, and pedestrian sections making up the route.\n","items":{"$ref":"#/components/schemas/RouterSection"}},"handle":{"type":"string","description":"Opaque handle of the calculated route.\n\nA handle encodes the calculated route. The route can be decoded from a handle at a\nlater point in time as long as the service uses the same map data which was used\nduring encoding.\n\nTo request a handle set the `routeHandle` flag in `return` parameter. If a handle is\nrequested, but fails to be calculated for any reason, then the `handle` property is\nnot available in the response. The rest of the route is intact.\n"}},"description":"A basic route. Includes personal vehicles as car, truck, etc... For all modes, cf. `transportMode`.\n"},"RouterRouteResponse":{"required":["routes"],"properties":{"notices":{"type":"array","description":"Contains a list of issues related to this route calculation.\nPlease refer to the `code` attribute for possible values.\n","items":{"$ref":"#/components/schemas/RouteResponseNotice"}},"routes":{"type":"array","description":"List of possible routes","items":{"$ref":"#/components/schemas/RouterRoute"}}},"description":"Returns a list of routes."},"inline_response_403":{"oneOf":[{"$ref":"#/components/schemas/AuthErrorResponseSchema"},{"$ref":"#/components/schemas/RoutingErrorResponse"}]},"Traffic":{"type":"object","properties":{"overrideFlowDuration":{"type":"integer","description":"Duration in seconds for which flow traffic event would be considered valid. While flow\ntraffic event is valid it will be used over the historical traffic data.\n\n**Note**: Flow traffic represents congestion not caused by any long-term incidents.\nState of the flow traffic often changes fast. The farther away from the current time we\nmove, the less precise current flow traffic data will be and the more precise historical\ntraffic data becomes. That's why it's advised not to use this parameter unless you know\nwhat you want to achieve and use the default behavior which is almost always better.\n"},"mode":{"type":"string","description":"Defines what traffic data should be used for route shape and travel duration calculation.\n\n* `default`: Traffic data is considered.\n*    - If `departureTime=any` then only long-term closures will be considered.\n*    - If `departureTime` is not equal to `any` then all traffic data will be taken into account.\n* `disabled`: All traffic data, including long term closures, is ignored.\n","enum":["default","disabled"],"default":"default"}},"description":"Traffic specific parameters."}},"responses":{"401ErrorResponseWithRequestID":{"description":"API response in case of unauthorized access.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthErrorResponseSchema"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/401errorResponseExample"}}}}},"500ErrorResponseWithRequestID":{"description":"API response in case of internal server error.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/500errorResponseExample"}}}}},"502ErrorResponseWithRequestID":{"description":"API response in case of bad gateway.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/502errorResponseExample"}}}}},"503ErrorResponseWithRequestID":{"description":"API response in case of service unavailable.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/503errorResponseExample"}}}}},"504ErrorResponseWithRequestID":{"description":"API response in case of gateway timeout.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/504errorResponseExample"}}}}},"HealthResponseFailWithRequestID":{"description":"API response in case of failure.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponseFailSchema"}},"text/plain":{}}},"HealthResponseOkWithRequestID":{"description":"API response in case of success.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponseOKSchema"}}}},"InternalServerErrorRoutesResponse":{"description":"Internal server error","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoutingErrorResponse"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/500RoutingErrorResponseExample"}}}}},"InvalidRoutesRequestResponse":{"description":"Failure to parse the request, caused by, for example, invalid parameter values such as\n`transportMode=spaceShuttle` or `alternatives=999`.\n\nNote that route calculation errors aren't considered failures. Cf. `RouterRouteResponse`\nfor details on route calculation errors.\n","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoutingErrorResponse"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/400RoutingErrorResponseExample"}}}}},"RoutesResponseOk":{"description":"Routes API response in case of success","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RouterRouteResponse"},"examples":{"routeResponseExample":{"$ref":"#/components/examples/routeResponseExample"}}}}},"Routing403ErrorResponse":{"description":"Not allowed, such as trying to calculate routes in Japan without having necessary\npermissions.\n","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_403"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/403RoutingErrorResponseExample"}}}}},"VersionResponseOkWithRequestID":{"description":"API response in case of success.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionResponse"}}}}},"parameters":{"alternatives":{"name":"alternatives","in":"query","description":"Number of alternative routes to return aside from the optimal route.","required":false,"style":"form","explode":true,"schema":{"maximum":6,"minimum":0,"type":"integer","default":0}},"avoid":{"name":"avoid","in":"query","description":"Avoid routes that violate certain features of road network or that go through\nuser-specified geographical bounding boxes.\n\nNote that if the origin, destination, or any via is in an avoided area or on an avoided\nfeature, a route is produced that violates the avoid restriction. In such a case, the\nroute is trying to minimize the violation of the avoid restrictions and can therefore\ninclude large deviations from a route that is calculated without these avoid\nrestrictions.\n\nIt is also possible that the produced route violates the avoid restriction in between\nwaypoints, if no other route is possible or too hard to find. One such example is\nrequesting a route to an island that is only reachable with ferries while specifying\n`avoid[features]=ferry`.\n\nFurther, avoid can cause the route calculation to fail, if no route is possible or too\nhard to find.\n\nSpecify properties using array notation like `avoid[features]=controlledAccessHighway,tunnel`.\n","required":false,"style":"deepObject","explode":false,"allowReserved":true,"schema":{"$ref":"#/components/schemas/Avoid"},"examples":{"features":{"summary":"Avoid specific features like `tunnel' or `ferry`","value":"avoid[features]=tunnel,ferry"},"area":{"summary":"Avoid a specific geographical bounding box","value":"avoid[areas]=bbox:13.082,52.416,13.628,52.626"},"areas":{"summary":"Avoid multiple geographical bounding boxes using `|` as element separator","value":"avoid[areas]=bbox:13.3127778,52.5106221,13.3495852,52.5255681|bbox:13.3958343,52.5171209,13.4286456,52.5405511"},"complete":{"summary":"Avoid both features and geographical bounding boxes","value":"avoid[features]=tollRoad,tunnel&avoid[areas]=bbox:13.082,52.416,13.628,52.626"},"zones":{"summary":"Avoid multiple environmental zones using identifiers"},"zoneCategory":{"summary":"Avoid all environmental zones","value":"avoid[zoneCategories]=environmental"},"zoneCategoryWithException":{"summary":"Avoid all environmental zones except a specific one"}}},"departureTimeWithAny":{"name":"departureTime","in":"query","description":"Specifies the time of departure as defined by either `date-time` or `full-date` `T`\n`partial-time` in `RFC 3339`, section 5.6 (for example, `2019-06-24T01:23:45`).\n\nThe requested time is converted to local time at origin. When the optional timezone offset\nis not specified, time is assumed to be local. The special value `any` can be used to\nindicate that time should not be taken into account during routing. If neither\n`departureTime` or `arrivalTime` are specified, current time at departure place will be\nused. All time values in the response are returned in the timezone of each location.\n","required":false,"style":"form","explode":true,"allowReserved":true,"schema":{"$ref":"#/components/schemas/TimeWithAny"}},"destination":{"name":"destination","in":"query","description":"A location defining destination of the trip.\n\n## Format\n\nFormat: `Place[WaypointOptions]`\n\n* Place: `{lat},{lng}[PlaceOptions]`\n* PlaceOptions: `;option1=value1;option2=value2...`\n* WaypointOptions: `!option1=value1!option2=value2...`\n\nA waypoint consists of:\n\n* Exactly one place\n* Optional settings for the place\n* Optional settings for the waypoint itself\n\nSupported place options:\n\n* `course`: int, degrees clock-wise from north. Indicating desired direction at the place.\n  E.g. `90` indicating `east`. Often combined with `radius` and/or `minCourseDistance`\n* `sideOfStreetHint`: `{lat},{lng}`. Indicating the side of the street that should be\n  used. E.g. if the location is to the left of the street, the router will prefer using\n  that side in case the street has dividers. E.g.\n  `52.511496,13.304140;sideOfStreetHint=52.512149,13.304076` indicates that the `north`\n  side of the street should be preferred. This option is required, if `matchSideOfStreet`\n  is set to `always`.\n* `matchSideOfStreet`: enum `[always, onlyIfDivided]`. Specifies how the location set by\n  `sideOfStreetHint` should be handled. Requires `sideOfStreetHint` to be specified as\n  well.\n  + `always` : Always prefer the given side of street.\n  + `onlyIfDivided`: Only prefer using side of street set by `sideOfStreetHint` in case\n    the street has dividers. This is the default behavior.\n* `nameHint`: string. Causes the router to look for the place with the most similar name.\n  This can e.g. include things like: `North` being used to differentiate between\n  interstates `I66 North` and `I66 South`, `Downtown Avenue` being used to correctly\n  select a residental street.\n* `radius`: int, meters. Asks the router to consider all places within the given radius as\n  potential candidates for route calculation. This can be either because it is not\n  important which place is used, or because it is unknown. Radius more than 200meter are\n  not supported.\n* `minCourseDistance`: int, meters. Asks the routing service to try find a route that avoids actions for\n  the indicated distance. E.g. if the origin is determined by a moving vehicle, the user\n  might not have time to react to early actions.\n\nSupported waypoint options:\n\n* `stopDuration`: desired duration for the stop, in seconds. The section arriving at this\n  via waypoint will have a `wait` post action reflecting the stopping time. The\n  consecutive section will start at the arrival time of the former section + stop\n  duration.\n* `passThrough`: option is not supported for 'destination'.\n\nNotes:\n\n* Non-structural reserved characters in options' values need to be properly percent-encoded.\n  Please refer to the developers' guide for more details.\n","required":true,"style":"form","explode":true,"allowReserved":true,"schema":{"$ref":"#/components/schemas/Waypoint"},"examples":{"coordinate":{"summary":"A simple WGS84 coordinate","value":"51.611571,11.351608"},"side":{"summary":"Populating sideOfStreetHint in addition to location to avoid ending on the wrong side of the street","value":"52.531052,13.384872;sideOfStreetHint=52.530941,13.384939;matchSideOfStreet=always"},"course":{"summary":"Setting course/radius/minCourseDistance an uncertain GPS coordinate of a moving vehicle","value":"51.611571,11.351608;course=170;radius=20;minCourseDistance=500"},"name":{"summary":"Setting nameHint to avoid matching to the wrong location","value":"52.510319,13.285616;nameHint=Kaiserdamm"},"duration":{"summary":"Addition a stopDuration for an intermediate stop","value":"51.611571,11.351608!stopDuration=600"}}},"ev":{"name":"ev","in":"query","required":false,"style":"deepObject","explode":false,"allowReserved":true,"schema":{"$ref":"#/components/schemas/EV"}},"exclude":{"name":"exclude","in":"query","description":"Defines properties which will be strictly excluded from route calculation.\n","required":false,"style":"deepObject","explode":false,"schema":{"$ref":"#/components/schemas/Exclude"}},"lang":{"name":"lang","in":"query","description":"Specifies the preferred language of the response. The value should comply with the [IETF BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"en-US"}},"origin":{"name":"origin","in":"query","description":"A location defining origin of the trip.\n\n## Format\n\nFormat: `Place[WaypointOptions]`\n\n* Place: `{lat},{lng}[PlaceOptions]`\n* PlaceOptions: `;option1=value1;option2=value2...`\n* WaypointOptions: `!option1=value1!option2=value2...`\n\nA waypoint consists of:\n\n* Exactly one place\n* Optional settings for the place\n* Optional settings for the waypoint itself\n\nSupported place options:\n\n* `course`: int, degrees clock-wise from north. Indicating desired direction at the place.\n  E.g. `90` indicating `east`. Often combined with `radius` and/or `minCourseDistance`\n* `sideOfStreetHint`: `{lat},{lng}`. Indicating the side of the street that should be\n  used. E.g. if the location is to the left of the street, the router will prefer using\n  that side in case the street has dividers. E.g.\n  `52.511496,13.304140;sideOfStreetHint=52.512149,13.304076` indicates that the `north`\n  side of the street should be preferred. This option is required, if `matchSideOfStreet`\n  is set to `always`.\n* `matchSideOfStreet`: enum `[always, onlyIfDivided]`. Specifies how the location set by\n  `sideOfStreetHint` should be handled. Requires `sideOfStreetHint` to be specified as\n  well.\n  + `always` : Always prefer the given side of street.\n  + `onlyIfDivided`: Only prefer using side of street set by `sideOfStreetHint` in case\n    the street has dividers. This is the default behavior.\n* `nameHint`: string. Causes the router to look for the place with the most similar name.\n  This can e.g. include things like: `North` being used to differentiate between\n  interstates `I66 North` and `I66 South`, `Downtown Avenue` being used to correctly\n  select a residental street.\n* `radius`: int, meters. Asks the router to consider all places within the given radius as\n  potential candidates for route calculation. This can be either because it is not\n  important which place is used, or because it is unknown. Radius more than 200meter are\n  not supported.\n* `minCourseDistance`: int, meters. Asks the routing service to try find a route that avoids actions for\n  the indicated distance. E.g. if the origin is determined by a moving vehicle, the user\n  might not have time to react to early actions.\n\nNotes:\n\n* `stopDuration` option is not supported for `origin`, contrary to `destination` and\n  `via` waypoints.\n* `passThrough`: option is not supported for 'origin'.\n* Non-structural reserved characters in options' values need to be properly percent-encoded.\n  Please refer to the developers' guide for more details.\n","required":true,"style":"form","explode":true,"allowReserved":true,"schema":{"$ref":"#/components/schemas/Waypoint"},"examples":{"coordinate":{"summary":"A simple WGS84 coordinate","value":"51.611571,11.351608"},"side":{"summary":"Populating sideOfStreetHint in addition to location to avoid ending on the wrong side of the street","value":"52.531052,13.384872;sideOfStreetHint=52.530941,13.384939;matchSideOfStreet=always"},"course":{"summary":"Setting course/radius/minCourseDistance an uncertain GPS coordinate of a moving vehicle","value":"51.611571,11.351608;course=170;radius=20;minCourseDistance=500"},"name":{"summary":"Setting nameHint to avoid matching to the wrong location","value":"52.510319,13.285616;nameHint=Kaiserdamm"},"duration":{"summary":"Addition a stopDuration for an intermediate stop","value":"51.611571,11.351608!stopDuration=600"}}},"pedestrianSpeed":{"name":"pedestrian[speed]","in":"query","description":"**Disclaimer: This parameter is currently in beta release, and is therefore subject to breaking changes.\nThe parameter could be extracted to a separate API if speed capping for cars/trucks is introduced**\nWalking speed in meters per second. Influences the duration of walking segments along the route.\n","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/PedestrianSpeed"}},"return":{"name":"return","in":"query","description":"Defines which attributes are included in the response as part of data representation of a\n`Route` or `Section`.\n\n* `polyline` - Polyline for the route in Flexible Polyline Encoding.\n  Either a 2D polyline (without `elevation` specified), or a 3D polyline with the 3rd dimension type `Elevation` (with `elevation` specified).\n* `actions` - Actions (such as maneuvers or tasks) that must be taken to complete the section.\n* `instructions` - Include instructions in returned actions. Instructions are localized to the requested language.\n* `summary` - Include summary for the section.\n* `travelSummary` - Include summary for the travel portion of the section.\n* `turnByTurnActions` - Include all information necessary to support turn by turn guidance to complete the section.\n* `mlDuration` - Use a region-specific machine learning model to calculate route duration. **Disclaimer: This parameter is currently in beta release, and is therefore subject to breaking changes.**\n* `elevation` - Include elevation information in coordinate and geometry types. See e.g. `polyline` or `location`.\n* `routeHandle` - Encode calculated route and return a handle which can be used with\n  `routes/{routeHandle}` to decode the route at a later point in time.\n* `passthrough` - Include information on passthrough via waypoints in the section.\n* `incidents` - Include a list of all incidents applicable to each section.\n                Incidents are localized to the requested language.\n                This requires `incidents` to be specified as part of the `return` parameter.\n* `routingZones` - Include information about routing zones each section goes through.\n\nFollowing restrictions apply when specifying return parameter:\n\n* If `actions` is requested, then `polyline` must also be requested as well.\n* If `instructions` is requested, then `actions` must also be requested as well.\n* If `turnByTurnActions` is requested, then `polyline` must also be requested as well.\n* If at least one attribute is requested within the `spans` parameter, then `polyline` must be request as well\n","required":false,"style":"form","explode":false,"schema":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/Return"}}},"routeHandle":{"name":"routeHandle","in":"path","description":"Route handle returned from a previous route calculation.\n\nSee `return` parameter of `/routes` endpoint for more information.\n","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},"routingMode":{"name":"routingMode","in":"query","description":"Specifies which optimization is applied during route calculation.\n\n* `fast`: Route calculation from start to destination optimized by travel time. In many\n  cases, the route returned by the `fast` mode may not be the route with the fastest\n  possible travel time. For example, the routing service may favor a route that remains on\n  a highway, even if a faster travel time can be achieved by taking a detour or shortcut\n  through an inconvenient side road.\n* `short`: Route calculation from start to destination disregarding any speed information.\n  In this mode, the distance of the route is minimized, while keeping the route sensible.\n  This includes, for example, penalizing turns. Because of that, the resulting route will\n  not necessarily be the one with minimal distance.\n\nNotes:\n* The following Transport modes only support `fast` routingMode\n  - `bicycle`\n  - `bus`\n  - `pedestrian`\n  - `scooter`\n  - `taxi`\n","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/RoutingMode"}},"scooter":{"name":"scooter","in":"query","description":"Scooter specific parameters.\n  * `allowHighway`: Specifies whether scooter is allowed on highway or not. This parameter is optional.\n    If not provided, then by default scooter is not allowed to use highway.\n    There is a similar parameter avoid[features]=controlledAccessHighway to disallow highway usage.\n    avoid[features] takes precedence so if this parameter is also used then scooters are not allowed\n    to use highways even if `allowHighway` is used with value as true.\n    Possible values:\n      * `true`: scooter is allowed to use highway.\n      * `false`: scooter is not allowed to use highway.\n","required":false,"style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/Scooter"}},"spans":{"name":"spans","in":"query","description":"Defines which attributes are included in the response spans. For example, `attributes,length`\nwill enable the fields `attributes` and `length` in the route response.\n\nThis parameter also requires that the `polyline` option is set within the `return` parameter.\n","required":false,"style":"form","explode":false,"schema":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/Spans"}}},"transportMode":{"name":"transportMode","in":"query","description":"Mode of transport to be used for the calculation of the route.\n\nNote:\n`taxi` and `bus` modes are in Alpha state. They are not yet stable and behaviour may change drastically, or even become unsupported, without warning.\n`taxi` and `bus` modes take into account taxi/bus restricted streets as well as streets reserved for exclusive taxi/bus access. It does not, however,\nconsider exclusive lanes in otherwise shared streets. Also, the streets that are for exclusive access for taxi/bus are used only if either the origin\nor destination are on them.\n","required":true,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/RouterMode"}},"truck":{"name":"truck","in":"query","description":"Truck specific parameters.\n  * `shippedHazardousGoods`:\n    Comma-separated list of shipped hazardous goods in the vehicle.\n    Possible values are:\n    * `explosive`: Explosive material\n    * `gas`: Gas\n    * `flammable`: Flammable material\n    * `combustible`: Combustible material\n    * `organic`: Organic material\n    * `poison`: Poison\n    * `radioactive`: Radioactive material\n    * `corrosive`: Corrosive material\n    * `poisonousInhalation`: Materials that are poisonous upon inhalation\n    * `harmfulToWater`: Materials that are harmful to water\n    * `other`: Other types of hazardous materials\n  * `grossWeight`: Vehicle weight including trailers and shipped goods, in kilograms.\n  * `weightPerAxle`: Vehicle weight per axle, in kilograms.\n  * `height`: Vehicle height, in centimeters.\n  * `width`: Vehicle width, in centimeters.\n  * `length`: Vehicle length, in centimeters.\n  * `tunnelCategory`: Specifies the tunnel category used to restrict transport of specific goods.\n    Possible values:\n      * `B`\n      * `C`\n      * `D`\n      * `E`\n  * `axleCount`: Defines total number of axles in the vehicle.\n  * `type`: Specifies the type of truck\n      * `straight`: a truck on a single frame with a permanently attached cargo area\n      * `tractor`: a towing vehicle that can pull one or more semi-trailers (aka semi-truck)\n  * `trailerCount`: Number of trailers attached to the vehicle.\n","required":false,"style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/Truck"}},"units":{"name":"units","in":"query","description":"Units of measurement used in guidance instructions. The default is `metric`.\n","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/Units"}},"vehicle":{"name":"vehicle","in":"query","required":false,"style":"deepObject","explode":false,"schema":{"$ref":"#/components/schemas/Vehicle"}},"via":{"name":"via","in":"query","description":"A location defining a via waypoint.\n\nA via waypoint is a location between origin and destination. The route will do a stop\nat the via waypoint.\n\nMultiple waypoints can also be specified using multiple via parameters like\n`via=...&via=...`, in which case the route will traverse these waypoints sequentially in\nthe order specified in the request.\n\n## Format\n\nFormat: `Place[WaypointOptions]`\n\n* Place: `{lat},{lng}[PlaceOptions]`\n* PlaceOptions: `;option1=value1;option2=value2...`\n* WaypointOptions: `!option1=value1!option2=value2...`\n\nA waypoint consists of:\n\n* Exactly one place\n* Optional settings for the place\n* Optional settings for the waypoint itself\n\nSupported place options:\n\n* `course`: int, degrees clock-wise from north. Indicating desired direction at the place.\n  E.g. `90` indicating `east`. Often combined with `radius` and/or `minCourseDistance`\n* `sideOfStreetHint`: `{lat},{lng}`. Indicating the side of the street that should be\n  used. E.g. if the location is to the left of the street, the router will prefer using\n  that side in case the street has dividers. E.g.\n  `52.511496,13.304140;sideOfStreetHint=52.512149,13.304076` indicates that the `north`\n  side of the street should be preferred. This option is required, if `matchSideOfStreet`\n  is set to `always`.\n* `matchSideOfStreet`: enum `[always, onlyIfDivided]`. Specifies how the location set by\n  `sideOfStreetHint` should be handled. Requires `sideOfStreetHint` to be specified as\n  well.\n  + `always` : Always prefer the given side of street.\n  + `onlyIfDivided`: Only prefer using side of street set by `sideOfStreetHint` in case\n    the street has dividers. This is the default behavior.\n* `nameHint`: string. Causes the router to look for the place with the most similar name.\n  This can e.g. include things like: `North` being used to differentiate between\n  interstates `I66 North` and `I66 South`, `Downtown Avenue` being used to correctly\n  select a residental street.\n* `radius`: int, meters. Asks the router to consider all places within the given radius as\n  potential candidates for route calculation. This can be either because it is not\n  important which place is used, or because it is unknown. Radius more than 200meter are\n  not supported.\n* `minCourseDistance`: int, meters. Asks the routing service to try find a route that avoids actions for\n  the indicated distance. E.g. if the origin is determined by a moving vehicle, the user\n  might not have time to react to early actions.\n\nSupported waypoint options:\n* `stopDuration`: desired duration for the stop, in seconds.\n* `passThrough`: boolean. Asks the router to avoid the following during route calculation:\n  + Introducing a stop at the waypoint.\n  + Splitting the route into sections.\n  + Changing the direction of travel.\n\n  Following scenarios are not supported for `passThrough` parameter:\n  + Setting both `stopDuration` to a value greater than 0 and `passThrough=true`.\n  + Setting `passThrough=true` for `origin` or `destination` of a route.\n  The default value is `false`.\n\nNotes:\n\n* Non-structural reserved characters in options' values need to be properly percent-encoded.\n  Please refer to the developers' guide for more details.\n","required":false,"style":"form","explode":true,"allowReserved":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/Waypoint"}},"examples":{"coordinate":{"summary":"A simple WGS84 coordinate","value":"51.611571,11.351608"},"side":{"summary":"Populating sideOfStreetHint in addition to location to avoid ending on the wrong side of the street","value":"52.531052,13.384872;sideOfStreetHint=52.530941,13.384939;matchSideOfStreet=always"},"course":{"summary":"Setting course/radius/minCourseDistance an uncertain GPS coordinate of a moving vehicle","value":"51.611571,11.351608;course=170;radius=20;minCourseDistance=500"},"name":{"summary":"Setting nameHint to avoid matching to the wrong location","value":"52.510319,13.285616;nameHint=Kaiserdamm"},"duration":{"summary":"Addition a stopDuration for an intermediate stop","value":"51.611571,11.351608!stopDuration=600"},"pass-through":{"summary":"Setting pass-through parameter to avoid possibly making a u-turn for a stop","value":"51.611571,11.351608!passThrough=true"}}},"xRequestId":{"name":"X-Request-ID","in":"header","description":"User-provided token that can be used to trace a request or a group of requests sent to the service.","required":false,"style":"simple","explode":false,"schema":{"type":"string"}}},"examples":{"400RoutingErrorResponseExample":{"value":{"title":"Malformed request","status":400,"code":"E605001","cause":"missing field `destination`","action":"","correlationId":"4199533b-6290-41db-8d79-edf4f4019a74"}},"401errorResponseExample":{"value":{"error":"Unauthorized","error_description":"No credentials found"}},"403RoutingErrorResponseExample":{"value":{"title":"Not allowed","status":403,"code":"E605101","cause":"Your credentials are not allowed to calculate routes in Japan","action":"Obtain credentials that allow you to calculate routes in Japan","correlationId":"4199533b-6290-41db-8d79-edf4f4019a74"}},"500RoutingErrorResponseExample":{"value":{"title":"Internal server error","status":500,"code":"E605500","cause":"","action":"","correlationId":"4199533b-6290-41db-8d79-edf4f4019a74"}},"500errorResponseExample":{"value":{"title":"failed with reason: internal server error","status":500,"code":"E600103","cause":"Internal Server Error","action":"","correlationId":""}},"502errorResponseExample":{"value":{"title":"failed with reason: bad gateway","status":502,"code":"E600002","cause":"Bad Gateway","action":"","correlationId":""}},"503errorResponseExample":{"value":{"title":"failed with reason: service unavailable","status":503,"code":"E600001","cause":"Service Unavailable","action":"","correlationId":""}},"504errorResponseExample":{"value":{"title":"failed with reason: gateway timeout","status":504,"code":"E600000","cause":"Gateway Timeout","action":"","correlationId":""}},"noticeWithRestrictionsExample":{"description":"Example of a notice indicating violation of a restriction that applies to vehicles\nover 12 tons and having between 2 and 4 axles (inclusive).\n","value":{"title":"Violated vehicle restriction.","code":"violatedVehiceRestriction","severity":"critical","details":[{"cause":"Route violates vehicle restriction","type":"restriction","maxGrossWeight":12000,"axleCount":{"from":2,"to":4}}]}},"restrictionExample":{"description":"Example modeling the following set of conditions which apply on one section of a road:\n* 12t weight\n* 3m height\n* forbidden transportation of gas\n","value":{"type":"restriction","maxGrossWeight":12000,"maxHeight":300,"forbiddenHazardousGoods":["gas"]}},"routeResponseExample":{"value":{"routes":[{"id":"1793a897-0843-4957-ab63-c61e0f13aff2","sections":[{"id":"c3e300ab-a880-4fab-9bb2-702355b2bf6b","type":"vehicle","actions":[{"action":"depart","duration":126,"instruction":"Head toward Chausseestraße on Invalidenstraße. Go for 1.2 km.","offset":0},{"action":"arrive","duration":0,"instruction":"Arrive at Invalidenstraße.","offset":78}],"departure":{"time":"2019-12-05T15:15:56+01:00","place":{"type":"place","location":{"lat":52.53100287169218,"lng":13.38464098982513}}},"arrival":{"time":"2019-12-05T15:18:02+01:00","place":{"type":"place","location":{"lat":52.52639072947204,"lng":13.368653766810894}}},"summary":{"duration":126,"length":1200},"polyline":"BG2znmkDi89wZ9ChKAA1IvfAArH5cAArHvbAA1CrJAArF5SAAtP9yBAAT1E3E3QAA_BrH3M9sBAA_F5SAA3KlkBAA1EtNAApB_DAAhC1EAApB1I_D5OAA3ErPAApFtTAAtN_wBAA1GtVAA5U3lCAA_DhOAA3KliBAAtXjvCAArDtLAA1EhQAA1CrJAA_BrFAAvbl9CAAhIvZ_FtTrDtLAAV1I1CtNAA1E3QAArLnoB1G5YAAhGhSpBrFAAhC1GAA1FxT","spans":[{"offset":0,"names":[{"value":"Invalidenstraße","language":"de"}],"length":787},{"offset":49,"names":[{"value":"Invalidenstraße","language":"de"},{"value":"Sandkrugbrücke","language":"de"}],"length":51},{"offset":57,"names":[{"value":"Invalidenstraße","language":"de"}],"length":362}],"transport":{"mode":"car"}}]}]}},"routeResponseNoticeExample":{"value":{"title":"Route calculation failed: Couldn't match origin.","code":"couldNotMatchOrigin","severity":"critical"}}},"headers":{"X-Correlation-Id":{"description":"Auto-generated id that univocally identifies the request.","style":"simple","explode":false,"schema":{"type":"string"},"example":"4199533b-6290-41db-8d79-edf4f4019a74"},"X-Request-Id":{"description":"User-provided token that can be used to trace a request or a group of requests sent to the service.","style":"simple","explode":false,"schema":{"type":"string"},"example":"8230d7ad-3f1c-4191-a8dd-f3c42026da89"}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","name":"X-API-Key","in":"header"}}}}