{"openapi":"3.0.2","info":{"title":"Routing API v8","version":"8.162.0","description":"A location service providing customizable route calculations for a variety of vehicle types as well as pedestrian modes.","termsOfService":"https://legal.here.com/en-gb/terms","license":{"name":"HERE Documentation License","url":"https://legal.here.com/en-gb/terms/documentation-license"}},"externalDocs":{"description":"The Developer guide, Release notes, and Migration guide are available here.","url":"https://www.here.com/docs/category/routing-api-v8"},"security":[{"Bearer":[]},{"ApiKey":[]}],"servers":[{"url":"https://router.hereapi.com/v8","description":"Production server for the HERE Routing Service"}],"tags":[{"name":"Routing"},{"name":"API Information","description":"Additional API Information"}],"paths":{"/routes":{"parameters":[{"$ref":"#/components/parameters/transportMode"},{"$ref":"#/components/parameters/origin"},{"$ref":"#/components/parameters/destination"},{"$ref":"#/components/parameters/via"},{"$ref":"#/components/parameters/departureTimeWithAny"},{"$ref":"#/components/parameters/arrivalTime"},{"$ref":"#/components/parameters/routingMode"},{"$ref":"#/components/parameters/alternatives"},{"$ref":"#/components/parameters/avoid"},{"$ref":"#/components/parameters/allow"},{"$ref":"#/components/parameters/exclude"},{"$ref":"#/components/parameters/units"},{"$ref":"#/components/parameters/lang"},{"$ref":"#/components/parameters/return"},{"$ref":"#/components/parameters/spans"},{"$ref":"#/components/parameters/truck"},{"$ref":"#/components/parameters/vehicle"},{"$ref":"#/components/parameters/consumptionModel"},{"$ref":"#/components/parameters/ev"},{"$ref":"#/components/parameters/fuel"},{"$ref":"#/components/parameters/driver"},{"$ref":"#/components/parameters/pedestrianSpeed"},{"$ref":"#/components/parameters/scooter"},{"$ref":"#/components/parameters/currency"},{"$ref":"#/components/parameters/customizations"},{"$ref":"#/components/parameters/taxi"},{"$ref":"#/components/parameters/tolls"},{"$ref":"#/components/parameters/maxSpeedOnSegment"},{"$ref":"#/components/parameters/traffic"},{"$ref":"#/components/parameters/networkRestrictedTruck"},{"$ref":"#/components/parameters/billingTag"},{"$ref":"#/components/parameters/xRequestId"}],"get":{"operationId":"Routing API v8 calculateRoutes","summary":"Calculate routes via GET","tags":["Routing"],"description":"Calculates a route using a generic vehicle/pedestrian mode, e.g. car, truck, pedestrian, etc...","responses":{"200":{"$ref":"#/components/responses/RoutesResponseOk"},"400":{"$ref":"#/components/responses/InvalidRoutesRequestResponse"},"401":{"$ref":"#/components/responses/401ErrorResponseWithRequestID"},"403":{"$ref":"#/components/responses/Routing403ErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorRoutesResponse"}}},"post":{"operationId":"Routing API v8 calculateRoutesPost","summary":"Calculate routes via POST","tags":["Routing"],"description":"Calculates a route using a generic vehicle/pedestrian mode, e.g. car, truck, pedestrian, etc...\n\nAt the moment, only selected parameters are permitted in the POST body,\nparticularly those that may be restricted in the query string due to request size limitations.\nSee the request body section below for details. All other parameters must be provided in the query string.\nIf a parameter is provided in both the query string and the POST body, their values are merged.\n\nPost body size limit is 10MiB.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalculateRoutesPostParameters"},"examples":{"avoid":{"$ref":"#/components/examples/calculateRoutesPostAvoidExample"},"exclude":{"$ref":"#/components/examples/calculateRoutesPostExcludeExample"},"ev":{"$ref":"#/components/examples/calculateRoutesPostEvExample"},"maxSpeedOnSegment":{"$ref":"#/components/examples/calculateRoutesPostMaxSpeedOnSegmentExample"},"networkRestrictedTruck":{"$ref":"#/components/examples/calculateRoutesPostNetworkRestrictedTruckExample"}}}}},"responses":{"200":{"$ref":"#/components/responses/RoutesResponseOk"},"400":{"$ref":"#/components/responses/InvalidRoutesRequestResponse"},"401":{"$ref":"#/components/responses/401ErrorResponseWithRequestID"},"403":{"$ref":"#/components/responses/Routing403ErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorRoutesResponse"}}}},"/routes/{routeHandle}":{"parameters":[{"$ref":"#/components/parameters/routeHandle"},{"$ref":"#/components/parameters/transportMode"},{"$ref":"#/components/parameters/routeHandleOrigin"},{"$ref":"#/components/parameters/departureTimeWithAny"},{"$ref":"#/components/parameters/avoid"},{"$ref":"#/components/parameters/allow"},{"$ref":"#/components/parameters/exclude"},{"$ref":"#/components/parameters/units"},{"$ref":"#/components/parameters/lang"},{"$ref":"#/components/parameters/return"},{"$ref":"#/components/parameters/spans"},{"$ref":"#/components/parameters/truck"},{"$ref":"#/components/parameters/vehicle"},{"$ref":"#/components/parameters/consumptionModel"},{"$ref":"#/components/parameters/evRouteHandle"},{"$ref":"#/components/parameters/fuel"},{"$ref":"#/components/parameters/pedestrianSpeed"},{"$ref":"#/components/parameters/scooter"},{"$ref":"#/components/parameters/currency"},{"$ref":"#/components/parameters/rerouting"},{"$ref":"#/components/parameters/taxi"},{"$ref":"#/components/parameters/tolls"},{"$ref":"#/components/parameters/maxSpeedOnSegment"},{"$ref":"#/components/parameters/traffic"},{"$ref":"#/components/parameters/networkRestrictedTruck"},{"$ref":"#/components/parameters/billingTag"},{"$ref":"#/components/parameters/xRequestId"}],"get":{"operationId":"Routing API v8 getRoutesByHandle","summary":"Get route by handle via GET","tags":["Routing"],"description":"Decodes and returns a route from a previously calculated route handle.\n\n**Disclaimer: A route handle is not suitable for persistent route storage! It can be\ninvalidated at any time.**\n\nA route handle encodes a previously calculated route. A route can be decoded from a handle\nas long as the service uses the same map data and encoding that were used when retrieving the handle.\n\nThus it is suitable for caching routes compactly. It can be used to retrieve updated traffic\ninformation or other data along the route. However, a user should be prepared to recalculate\nthe route when decoding the handle fails.\n\nAll parameters of the `/routes` endpoint are supported, except for `destination`, `via`,\n`alternatives` and `routingMode`. See also the `return` parameter of `/routes` endpoint.\n\nThe `origin` parameter can be provided to update the start of the previously calculated\nroute.\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\nPlease refer to the Developer Guide for more information and examples.\n","responses":{"200":{"$ref":"#/components/responses/RoutesResponseOk"},"400":{"$ref":"#/components/responses/InvalidRoutesRequestResponse"},"401":{"$ref":"#/components/responses/401ErrorResponseWithRequestID"},"403":{"$ref":"#/components/responses/Routing403ErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorRoutesResponse"}}},"post":{"operationId":"Routing API v8 getRoutesByHandlePost","summary":"Get route by handle via POST","tags":["Routing"],"description":"Decodes and returns a route from a previously calculated route handle.\n\n**Disclaimer: A route handle is not suitable for persistent route storage! It can be\ninvalidated at any time.**\n\nA route handle encodes a previously calculated route. A route can be decoded from a handle\nas long as the service uses the same map data and encoding that were used when retrieving the handle.\n\nThus it is suitable for caching routes compactly. It can be used to retrieve updated traffic\ninformation or other data along the route. However, a user should be prepared to recalculate\nthe route when decoding the handle fails.\n\nAll parameters of the `/routes` endpoint are supported, except for `destination`, `via`,\n`alternatives` and `routingMode`. See also the `return` parameter of `/routes` endpoint.\n\nThe `origin` parameter can be provided to update the start of the previously calculated\nroute.\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\nOnly selected parameters are permitted in the POST body. See the request body section below for details.\nIf a parameter is provided in both the query string and the POST body, their values are merged.\n\nPost body size limit is 10MiB.\n\nPlease refer to the Developer Guide for more information and examples.\n","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRoutesByHandlePostParameters"},"examples":{"avoid":{"$ref":"#/components/examples/calculateRoutesPostAvoidExample"},"exclude":{"$ref":"#/components/examples/calculateRoutesPostExcludeExample"},"maxSpeedOnSegment":{"$ref":"#/components/examples/calculateRoutesPostMaxSpeedOnSegmentExample"},"networkRestrictedTruck":{"$ref":"#/components/examples/calculateRoutesPostNetworkRestrictedTruckExample"}}}}},"responses":{"200":{"$ref":"#/components/responses/RoutesResponseOk"},"400":{"$ref":"#/components/responses/InvalidRoutesRequestResponse"},"401":{"$ref":"#/components/responses/401ErrorResponseWithRequestID"},"403":{"$ref":"#/components/responses/Routing403ErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorRoutesResponse"}}}},"/import":{"post":{"operationId":"Routing API v8 importRoute","summary":"Calculate a route from a sequence of trace points","tags":["Routing"],"description":"Creates a route from a sequence of trace points.\n\nPost body size limit is 10MiB.\n\nFor best results, use 1Hz GPS data or any points that have a spacing of a few meters between them.\nFor traces with less frequent points, the Route Import service will attempt to create an approximate reconstruction.\nIn some situations, when consecutive points are too far apart (more than about 30 kilometers of on-road distance), they could be considered unreachable and one of them could fail to be matched.\n","parameters":[{"$ref":"#/components/parameters/transportMode"},{"$ref":"#/components/parameters/departureTimeWithAny"},{"$ref":"#/components/parameters/avoid"},{"$ref":"#/components/parameters/allow"},{"$ref":"#/components/parameters/exclude"},{"$ref":"#/components/parameters/units"},{"$ref":"#/components/parameters/lang"},{"$ref":"#/components/parameters/return"},{"$ref":"#/components/parameters/spans"},{"$ref":"#/components/parameters/truck"},{"$ref":"#/components/parameters/vehicle"},{"$ref":"#/components/parameters/consumptionModel"},{"$ref":"#/components/parameters/evRouteImport"},{"$ref":"#/components/parameters/fuel"},{"$ref":"#/components/parameters/scooter"},{"$ref":"#/components/parameters/taxi"},{"$ref":"#/components/parameters/billingTag"},{"$ref":"#/components/parameters/xRequestId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchTrace"}}}},"responses":{"200":{"$ref":"#/components/responses/RoutesResponseOk"},"400":{"$ref":"#/components/responses/InvalidRoutesRequestResponse"},"401":{"$ref":"#/components/responses/401ErrorResponseWithRequestID"},"403":{"$ref":"#/components/responses/Routing403ErrorResponse"},"429":{"$ref":"#/components/responses/Routing429ErrorResponse"},"500":{"$ref":"#/components/responses/InternalServerErrorRoutesResponse"}}}},"/health":{"get":{"operationId":"Routing API v8 getHealth","summary":"Health status of the service","tags":["API Information"],"description":"Returns the health of the service","parameters":[{"$ref":"#/components/parameters/xRequestId"}],"security":[],"responses":{"200":{"$ref":"#/components/responses/HealthResponseOkWithRequestID"},"default":{"$ref":"#/components/responses/HealthResponseFailWithRequestID"}}}},"/version":{"get":{"operationId":"Routing API v8 getVersion","summary":"Full version of the API","tags":["API Information"],"description":"Returns the version of the service","parameters":[{"$ref":"#/components/parameters/xRequestId"}],"security":[],"responses":{"200":{"$ref":"#/components/responses/VersionResponseOkWithRequestID"},"500":{"$ref":"#/components/responses/500ErrorResponseWithRequestID"},"502":{"$ref":"#/components/responses/502ErrorResponseWithRequestID"},"503":{"$ref":"#/components/responses/503ErrorResponseWithRequestID"},"504":{"$ref":"#/components/responses/504ErrorResponseWithRequestID"}}}},"/openapi":{"get":{"summary":"Retrieves this API specification in OpenAPI 3 format","operationId":"Routing API v8 getOpenapi","tags":["API Information"],"parameters":[{"$ref":"#/components/parameters/xRequestId"}],"security":[],"responses":{"200":{"$ref":"#/components/responses/OpenApiResponseOk"},"500":{"$ref":"#/components/responses/500ErrorResponseWithRequestID"},"502":{"$ref":"#/components/responses/502ErrorResponseWithRequestID"},"503":{"$ref":"#/components/responses/503ErrorResponseWithRequestID"},"504":{"$ref":"#/components/responses/504ErrorResponseWithRequestID"}}}}},"components":{"parameters":{"allow":{"name":"allow","description":"Explicitly allow features that require users to opt in.","in":"query","required":false,"explode":true,"style":"deepObject","schema":{"$ref":"#/components/schemas/Allow"}},"alternatives":{"name":"alternatives","description":"Number of alternative routes to return aside from the optimal route.","in":"query","required":false,"schema":{"type":"integer","minimum":0,"maximum":6,"default":0}},"arrivalTime":{"name":"arrivalTime","description":"Specifies the time of arrival as defined by either `date-time` or `full-date` `T` `partial-time` in `RFC 3339`, section 5.6 (for example, `2019-06-24T01:23:45`).\nThe requested time is converted to the local time at destination. When the optional timezone offset is\nnot specified, time is assumed to be local.\nAll `Time` values in the response are returned in the timezone of each location.\n\nNote : The following features do not support the arrivalTime parameter:\n* EV Routing\n* Route Handle\n* Route Import\n","in":"query","allowReserved":true,"required":false,"schema":{"$ref":"#/components/schemas/Time"}},"avoid":{"name":"avoid","description":"Avoid roads that violate certain features of road network or that go through\nuser-specified areas, segments, or zones.\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\nWhen using avoid features, it's not guaranteed to get alternatives. Further, they can even\ncause the route calculation to fail, if no route is possible or too hard to find.\n","in":"query","allowReserved":true,"required":false,"explode":true,"style":"deepObject","schema":{"$ref":"#/components/schemas/Avoid"},"examples":{"features":{"summary":"Avoid specific features like `tunnel' or `ferry`","value":{"features":"tunnel,ferry"}},"area":{"summary":"Avoid a specific geographical bounding box","value":{"areas":"bbox:13.082,52.416,13.628,52.626"}},"areas":{"summary":"Avoid multiple geographical bounding boxes using `|` as element separator","value":{"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":{"features":"tollRoad,tunnel&avoid[areas]=bbox:13.082,52.416,13.628,52.626"}},"segment":{"summary":"Avoid a segment using its identifier","value":{"segments":"here:cm:segment:207551710"}},"segmentsWithDirection":{"summary":"Avoid two segments using their identifiers, also specifying the direction","value":{"segments":"here:cm:segment:207551710#+,here:cm:segment:76771992#*"}},"zones":{"summary":"Avoid multiple environmental zones using identifiers","value":{"zoneIdentifiers":"here:cm:envzone:2,here:cm:envzone:3"}},"zoneCategory":{"summary":"Avoid all environmental zones","value":{"zoneCategories":"environmental"}},"zoneCategoryWithException":{"summary":"Avoid all environmental zones except a specific one","value":{"zoneCategories":"environmental;exceptZoneIds=here:cm:envzone:2"}},"truckRoadTypes":{"summary":"Avoid the specified truck road types","value":{"truckRoadTypes":"BK1,BK2,BK3,BK4"}},"tollTransponders":{"summary":"Avoid all toll transponders","value":{"tollTransponders":"all"}}}},"billingTag":{"name":"billingTag","in":"query","description":"A list of up to six billing tags, separated by the `+` sign.\n\nThis parameter provides a way to track your platform usage.\nFor details, refer to the Cost Management Developer Guide section on [Billing Tags](https://docs.here.com/usage/docs/tutorial-billing-tags)\n","schema":{"type":"string","pattern":"^(?![_-])[A-Za-z0-9_-]{4,16}(?;option2=...`\n* WaypointOptions: `!option1=!option2=...`\n\nA waypoint consists of:\n\n* Exactly one place\n* Optional settings for the place\n* Optional settings for the waypoint itself\n\n## Supported 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 Option cannot be combined with `radius`, `radiusPenalty` or `snapRadius`.\n* `displayLocation`: `{lat},{lng}`. Indicates the location on the map where this POI is to be displayed. This attribute is passed through to the `displayLocation` attribute in the corresponding `Place` object in the output.\n* `uTurnPermission`: enum `[allow, avoid]`. Specifies the U-Turn Permission mode at the stop-over waypoint. If unspecified, the permission will be determined by the global setting, avoid[features]=uTurns. This feature is not supported for pass-through waypoints and U-Turns are generally avoided in that case.\n + `allow` : Allow making a U-Turn at this stop-over waypoint\n + `avoid` : Avoid making a U-Turn at this stop-over waypoint\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 The typical examples include: `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\n Empty string values are ignored.\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. Radiuses wider than 200 meters are\n not supported.\n Option cannot be combined with `snapRadius`.\n* `radiusPenalty`: int, percentage 0-10000. Penalty as percentage: Used in conjunction with the `radius`\n parameter. Router will match the waypoint within the specified radius and apply a penalty to candidates\n based on their air distance to the waypoint. This penalty is proportional to the given percentage,\n where 100 is just the cost of the air distance, and 200 is twice the cost of the air distance. The penalty\n must be chosen so that, when multiplied by the radius, the result is less than or equal to 7200.\n Regardless, only values up to and including 10000 will be accepted. This means that a maximum penalty\n of 3600% is allowed for a radius of 200m, 7200% for 100m and 10000% for 72m and less.\n Higher values will result in an error response. `radiusPenalty` cannot be combined with `snapRadius`.\n **Alpha**: This parameter is in development. It may not be stable and is subject to change.\n* `snapRadius`: int, meters. Instructs the router to match the waypoint, within the specified radius,\n to the most \"significant\" road. In contrast to the regular `radius` parameter, `snapRadius` sorts potential\n candidates in order of \"significance\". For example, a highway is more significant on a zoomed-out map than\n a national road, a national road is more significant than a city road, etc. Hence, `snapRadius` cannot be\n combined with `radius` or `radiusPenalty` parameters. The typical use case for `snapRadius` is when selecting a waypoint on a\n zoomed-out view of a map on a drag-and-drop interface. The expectation on such UIs is that only roads that\n are visible at that zoom level are considered for matching and a large snapRadius would enable that.\n* `minCourseDistance`: int, meters. Instructs the routing service to try to find a route that avoids actions for the indicated distance.\n For example, if the origin is determined by a moving vehicle, the user might not have time to react to early actions.\n Values greater than 2000 meters will be capped at 2000 meters.\n* `segmentIdHint`: string. Causes the router to try and match to the specified segment.\n Waypoint coordinates need to be on the segment, otherwise waypoint will be matched ignoring the segment hint\n This parameter can be used when the waypoint is too close to more than one segment to force matching to a specific one.\n* `onRoadThreshold`: int, meters. allows specifying a distance within which\n the waypoint could be considered as being on a highway/bridge/tunnel/sliproad.\n Within this threshold, the attributes of the segments do not impact the matching.\n Outside the threshold only segments which aren't one of highway/bridge/tunnel/sliproad can be matched.\n\n## Notes\n\n* `origin` currently does not support any WaypointOptions. They are available for `via` and `destination` waypoints.\n* Non-structural reserved characters in options' values need to be properly percent-encoded.\n Please refer to the Developer Guide for more details.\n","in":"query","allowReserved":true,"required":true,"schema":{"$ref":"#/components/schemas/Waypoint"},"examples":{"coordinate":{"value":"51.611571,11.351608","summary":"A simple WGS84 coordinate"},"side":{"value":"52.531052,13.384872;sideOfStreetHint=52.530941,13.384939;matchSideOfStreet=always","summary":"Populating sideOfStreetHint in addition to location to avoid ending on the wrong side of the street"},"course":{"value":"51.611571,11.351608;course=170;radius=20;minCourseDistance=500","summary":"Setting course/radius/minCourseDistance an uncertain GPS coordinate of a moving vehicle"},"name":{"value":"52.510319,13.285616;nameHint=Kaiserdamm","summary":"Setting nameHint to avoid matching to the wrong location"},"displayLocation":{"value":"52.52697,13.42500;displayLocation=52.51885,13.46237","summary":"This coordinate is the location of the POI as shown by the pin on a map."}}},"pedestrianSpeed":{"name":"pedestrian[speed]","description":"Walking speed in meters per second. Influences the duration of walking segments along the route.\n","in":"query","schema":{"$ref":"#/components/schemas/PedestrianSpeed"}},"rerouting":{"name":"rerouting","description":"Rerouting parameters allow to request a new route calculation based on the route handle.\n\nAll attributes are optional.\n","in":"query","required":false,"explode":true,"style":"deepObject","schema":{"$ref":"#/components/schemas/Rerouting"}},"return":{"name":"return","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](https://github.com/heremaps/flexible-polyline) Encoding.\n Either a 2D polyline (without `elevation` specified), or a 3D polyline with the 3rd dimension type `Elevation` (with `elevation` specified), using the WGS84 coordinate system.\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` - (Deprecated) No longer returns a value. The parameter is still accepted for backwards compatibility.\n* `typicalDuration` - Include route duration under typical traffic conditions.\n* `elevation` - Include WGS84 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 Returned incidents may be referenced by `incidents` and/or `intersectionIncidents` span parameters.\n Incidents are localized to the requested language.\n* `routingZones` - Include information about routing zones each section goes through.\n* `truckRoadTypes` - Include information about road types each section goes through.\n* `tolls` - Include information about the tolls to be paid, per section, according to the `tolls` parameter and other toll-influencing\n parameters such as vehicle dimensions in the query,\n e.g `transportMode`, `vehicle[hovOccupancy]`, vehicle[height]. Check the Developer Guide for tutorials on the topic.\n If tolls cannot be calculated for a section, it will contain the `tollsDataUnavailable` notice code.\n\n **Note**:\n - Toll requests support `car` dimensions such as atypical car height and weight, trailers, axle count and vehicle fuel type. However extreme parameter combinations may result in tolls being returned for a different vehicle type (for example, a car with 6 axles will most likely result in truck tolls).\n Therefore the request will return the most \"typical\" toll cost for the parameters provided.\n - Tolls are not available in route import service. See [this tutorial](https://docs.here.com/routing/docs/routing-v8-tolls-routeimport) for information on how to request tolls when using route import.\n* `routeLabels` - Include a list of the most important names and route numbers on this route that differentiate it from other alternatives\n* `potentialTimeDependentViolations` - Include info notices for potential time-dependent violations in the sections that match the current vehicle profile, but are not violating the restricted times for the calculated route.\n* `noThroughRestrictions` - Include information about the parts of the route that are not allowed to be driven through, i.e. route can only start, end, or have an intermediate `via` waypoint here.\n\nThe following restrictions apply when specifying the `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","in":"query","schema":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/Return"}},"style":"form","explode":false},"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,"schema":{"type":"string"}},"routeHandleOrigin":{"name":"origin","description":"A location defining the origin of the trip. The origin has to be located along the\npreviously calculated route.\n\nFor a description of the format and options for this parameter, please refer to the description of\nthe `origin` parameter in `Calculate routes via GET`.\n\nThis parameter supports the same options as the `origin` parameter in `Calculate routes via GET`,\nwith the following exceptions:\n\n## Notes\n\n* `minCourseDistance`: While this parameter can be provided for compatibility reasons,\n it will not affect the result of a getRoutesByHandle request.\n","in":"query","allowReserved":true,"required":false,"schema":{"$ref":"#/components/schemas/Waypoint"},"examples":{"coordinate":{"value":"51.611571,11.351608","summary":"A simple WGS84 coordinate"},"side":{"value":"52.531052,13.384872;sideOfStreetHint=52.530941,13.384939;matchSideOfStreet=always","summary":"Populating sideOfStreetHint in addition to location to avoid ending on the wrong side of the street"},"course":{"value":"51.611571,11.351608;course=170;radius=20","summary":"Setting course/radius an uncertain GPS coordinate of a moving vehicle"},"name":{"value":"52.510319,13.285616;nameHint=Kaiserdamm","summary":"Setting nameHint to avoid matching to the wrong location"},"displayLocation":{"value":"52.52697,13.42500;displayLocation=52.51885,13.46237","summary":"This coordinate is the location of the POI as shown by the pin on a map."}}},"routingMode":{"name":"routingMode","description":"Specifies which optimization is applied during the calculation.\n\n* `fast`: Route calculation from start to destination optimized by travel time. In many\n cases, the route returned by `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 - `privateBus`\n - `scooter`\n - `taxi`\n - `networkRestrictedTruck`\n","in":"query","required":false,"schema":{"$ref":"#/components/schemas/RoutingMode"}},"scooter":{"name":"scooter","description":"Scooter-specific parameters.\n * `allowHighway`: Specifies whether the scooter is allowed on highways or not. This parameter is optional.\n If not provided, the default is to avoid highways.\n There is a similar parameter avoid[features]=controlledAccessHighway to disallow highway usage.\n avoid[features] takes precedence, so if that parameter is also used, scooters are not allowed\n to use highways even if `allowHighway` is set to `true`.\n The following values are possible:\n * `true`: The scooter is allowed to use highways.\n * `false`: The scooter is not allowed to use highways.\n","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/Scooter"}},"spans":{"name":"spans","in":"query","required":false,"description":"Defines which map content attributes are included in the response spans. For example, `attributes,length` will enable the fields `attributes` and `length` in the route response.\nFor more information about the `countryCode` field, see the [ISO standard](https://www.iso.org/obp/ui/#search).\n\nThis parameter also requires that the `polyline` option is set within the `return` parameter.\n\n**NOTE:** Attribute speedLimit is deprecated, use maxSpeed instead. Attribute segmentId is deprecated, use segmentRef instead.\n","style":"form","explode":false,"schema":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/Spans"}}},"taxi":{"name":"taxi","description":"Taxi-specific parameters.\n * `allowDriveThroughTaxiRoads`: Specifies if a vehicle is allowed to drive through\n taxi-only roads and lanes. Even if this option is set to `false`, the vehicle is still\n allowed on taxi-only roads at the start of the route and at the destination.\n","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/Taxi"}},"tolls":{"name":"tolls","description":"Defines properties which control toll calculation and reporting in the response.\n","in":"query","required":false,"explode":true,"style":"deepObject","schema":{"$ref":"#/components/schemas/Tolls"}},"traffic":{"name":"traffic","description":"Traffic specific parameters.","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/Traffic"}},"transportMode":{"name":"transportMode","description":"Mode of transport to be used for the calculation of the route.\n\nNote:\n`bicycle`, `bus`, `privateBus` and `networkRestrictedTruck` modes are currently provided as Beta, with limited functionality.\nPlease refer to the Developer Guide for more details.\n\n`networkRestrictedTruck` transport mode requires the use of the `networkRestrictedTruck[permittedNetworks]` parameter.\n\nAdditionally, `networkRestrictedTruck` transport mode cannot use any of the following parameters that are otherwise allowed for trucks:\n- `avoid[features]` with any of `tollRoad`, `controlledAccessHighway`, `carShuttleTrain`, `difficultTurns`\n- `avoid[truckRoadTypes]`\n- `vehicle[occupancy]`\n- `vehicle[engineType]`\n- `vehicle[kpraLength]`\n- `vehicle[category]`\n- any `ev[*]` parameters\n- any `fuel[*]` parameters\n","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RouterMode"}},"truck":{"name":"truck","description":"Truck-specific parameters.\n\n**NOTE:** The attribute `truck` is deprecated and should be replaced with `vehicle`.\n","deprecated":true,"in":"query","required":false,"style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/Truck"}},"units":{"name":"units","description":"Units of measurement used in guidance instructions. The default is `metric`.\n","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Units"}},"vehicle":{"name":"vehicle","description":"Vehicle-specific parameters.\n","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"$ref":"#/components/schemas/Vehicle"}},"via":{"name":"via","description":"A location defining a via waypoint.\n\nA via waypoint is a location between origin and destination. There are two types of via waypoints:\n* `passThrough=false` (default) : The route will stop at the via waypoint, creating a new route section.\n* `passThrough=true` : The route will pass through the via waypoint.\n\nMultiple waypoints can be specified by 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\nFor a description of the format and options for this parameter, please refer to the description of\nthe `origin` parameter.\n`via` supports the same options as the `origin` parameter, with the following exceptions:\n\n## Additional waypoint options:\n* `stopDuration`: desired duration for the stop, in seconds. Must be less than 50000.\n* `passThrough`: boolean. Default value is `false`.\n Setting to `true` 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 The following scenarios are not supported for `passThrough` parameter:\n + Setting both `stopDuration` to a value greater than 0 and `passThrough=true`.\n\n* `charging`: Structured string denoting a user-planned charging stop.\n\n Format: `charging=(power=;current=;voltage=;supplyType=;minDuration=;maxDuration=)`.\n\n The properties `power`, `current`, `voltage` and `supplyType` denote the characteristics of the chosen compatible connector at the station. These are all required.\n `minDuration` and `maxDuration` set the time bounds for the charging time. At least one of them is required. For most use cases we recommend to provide at least `minDuration`.\n The following are the specifications for the properties:\n + `power`: value in kW, type: number. Rated power of the connector.\n + `voltage`: value in V, type: number. Rated voltage of the connector.\n + `current`: value in A, type: number. Rated current of the connector.\n + `supplyType`: one of {\"acSingle\", \"acThree\", \"dc\"} for 1-phase AC, 3-phase AC and DC respectively, type: string.\n + `minDuration`: value in seconds, type: int. Minimum time the user expects to charge at the station, including `chargingSetupDuration`. This value takes precedence over the global `maxChargingDuration`.\n + `maxDuration`: value in seconds, type: int. Maximum time the user plans to charge at the station, including `chargingSetupDuration`. This value takes precedence over the global `maxChargingDuration`.\n\n For a user-planned charging stop, the following properties of the `ev` parameter are also required (see documentation for the `ev` parameter):\n * `initialCharge`\n * `maxCharge`\n * `chargingCurve`\n\n *Notes*:\n * This option is not supported for pass-through waypoints.\n * If `makeReachable=true` and `minDuration` is not provided (or if `minDuration=0`), route calculation may suggest not to charge on this station, for example,\n if a better station is available in the vicinity.\n * If `stopDuration` is provided then the total time at the stop is the higher of (`stopDuration`, `chargingSetupDuration` + `chargingDuration`).\n * If charging for `minDuration` would charge above `maxCharge`, the time spent charging is capped by `maxCharge`.\n * If `stopDuration` or `minDuration` exceed `chargingSetupDuration` + `chargingDuration`, the `waiting` post action duration is set to the remaining time.\n * If `makeReachable=true` is not set, the target charge is `maxChargeAfterChargingStation`, unless the charging time would be outside of the specified duration range.\n In such case, the nearest valid value is used.\n * In getRoutesByHandle requests, the target charge from the original route response is used, unless the charging time would be outside of the specified duration range.\n In such case, the nearest valid value is used.\n\n* `currentWeightChange`: Changes the value of `vehicle[currentWeight]` by this value. Enables the support of scenarios where the vehicle takes additional cargo or unloads its cargo along the route. Changes to the configuration of the vehicle, such as adding a trailer, aren't supported.\nRelative value in kilograms, beginning with either `+` or `-`. Available range: from -40000 to +40000 (inclusive).\n\n If this parameter is specified on any of the via waypoints or the request has the `vehicle[currentWeight]` set, the response contains the `currentWeight` value used for each section.\n\n When this parameter is provided, both `vehicle[currentWeight]` and `vehicle[grossWeight]` must also be provided.\n\n If the `currentWeight` value falls below 0 due to `currentWeightChange`, the system returns a critical violation notice, but a route is still calculated. The system returns notices only for negative values. Very low positive values are likely invalid, but don't trigger notices since they are greater than 0.\n\n The `currentWeightChange` value is stored in the `RouteHandle` at each waypoint and can't be changed in `RouteHandle` calculation requests.\n\n* `auxiliaryEnergyConsumption`: value in kWh, type: number. Auxiliary energy consumption during normal stop. This is to specify the expected energy consumption from the vehicle's battery by powered equipment, like a tail-lift used to load/unload goods, during the stop.\n **Notes:**\n * Cannot be used with `passThrough=true`\n * Cannot be used at user-added charging stations.\n","in":"query","allowReserved":true,"style":"form","explode":true,"required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/Waypoint"}},"examples":{"coordinate":{"value":"51.611571,11.351608","summary":"A simple WGS84 coordinate"},"side":{"value":"52.531052,13.384872;sideOfStreetHint=52.530941,13.384939;matchSideOfStreet=always","summary":"Populating sideOfStreetHint in addition to location to avoid ending on the wrong side of the street"},"course":{"value":"51.611571,11.351608;course=170;radius=20;minCourseDistance=500","summary":"Setting course/radius/minCourseDistance an uncertain GPS coordinate of a moving vehicle"},"name":{"value":"52.510319,13.285616;nameHint=Kaiserdamm","summary":"Setting nameHint to avoid matching to the wrong location"},"duration":{"value":"51.611571,11.351608!stopDuration=600","summary":"Addition a stopDuration for an intermediate stop"},"pass-through":{"value":"51.611571,11.351608!passThrough=true","summary":"Setting pass-through parameter to avoid possibly making a u-turn for a stop"},"displayLocation":{"value":"52.52697,13.42500;displayLocation=52.51885,13.46237","summary":"This coordinate is the location of the POI as shown by the pin on a map."},"currentWeightChange":{"value":"52.531052,13.384872!currentWeightChange=+500","summary":"Adding a weight of 500 kg to the vehicle for the remainder of the route."},"charging":{"value":"51.611571,11.351608!charging=(power=100;current=250;voltage=400;supplyType=dc;minDuration=1200)","summary":"Waypoint with a 100 kW charging station; charging at this station for at least 20 minutes."}}},"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.","schema":{"type":"string"}}},"headers":{"X-Correlation-Id":{"description":"Auto-generated id that univocally identifies the request.","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.","schema":{"type":"string"},"example":"8230d7ad-3f1c-4191-a8dd-f3c42026da89"}},"securitySchemes":{"ApiKey":{"type":"apiKey","in":"query","name":"apiKey","description":"A key generated specifically to authenticate API requests. For more information\non how to get an API key, see [Identity and Access Management Developer Guide](https://docs.here.com/identity-and-access-management/docs/readme).\n"},"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token obtained from a separate endpoint using client credentials and an OAuth 1.0a HMAC-SHA256 signed request.\nFor more information on how to get a bearer token, see the [Identity and Access Management Developer Guide](https://docs.here.com/identity-and-access-management/docs/readme).\n"}},"schemas":{"AccessAttributes":{"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`: A part of the route that can be traversed.\n* `noThrough`: A part of the route that can only be traversed if origin, destination or any via waypoint is located there.\n* `tollRoad`: Access to this part of the route is restricted with a fee (or toll).\n\nIt is possible that new access attributes may be supported in the future. When encountering unknown access attributes, e.g., in the software parser, it is recommended to ignore them.\n","type":"string","x-extensible-enum":["open","noThrough","tollRoad"]},"Allow":{"type":"object","description":"Explicitly allow features that require users to opt in.","properties":{"hov":{"description":"This parameter specifies whether HOV lanes can be used in the calculation.\n\nAn HOV (High occupancy Vehicle) lane or carpool lane is reserved for carpool usage.\nCarpool lane requires a minimum number of passengers in order for the car to use the\ncarpool lane.\n\n**Notes**:\n- This parameter can't be used with 'vehicle[hovOccupancy]'.\n- This parameter should be used with `vehicle[occupancy]`. If `vehicle[occupancy]` is set, then only HOV lanes allowing this number of occupants will be allowed. If `vehicle[occupancy]` is not set, occupancy requirements are always considered fulfilled.\n- In case of violation, `violatedCarpool` notice will be returned.\n","type":"boolean","default":false},"hot":{"description":"This parameter specifies whether HOT lanes can be used in the calculation.\n\nHOT (high-occupancy toll) lanes are HOV lanes where vehicles that do not qualify as high-occupancy are allowed to pass by paying a toll.\n\n**Notes**:\n- This parameter can't be used with 'vehicle[hovOccupancy]'.\n- This parameter can be used with `allow[hov]`.\n- In case of violation, `violatedCarpool` notice will be returned.\n- No toll information is returned for HOT lanes since it is dynamic information.\n","type":"boolean","default":false}}},"Areas":{"description":"A pipe separated list of user-defined areas that routes should avoid/exclude going through.\n\nNotes:\n* Maximum count of avoided and excluded polygons and corridors is 20.\n* Maximum total count of avoided and excluded bounding boxes, polygons, corridors, including exceptions, is 250.\n\nFormat: `{area1}[!exception1.1[!exception1.2...]]|{area2}[!exception2.1[!exception2.2...]]|{area3}[!exception3.1[!exception3.2...]]...`\n\nSupported areas:\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* Polygon - A polygon on earth which defines area.\n Possible formats:\n 1) As list of geopoints.\n - Format: `polygon:{lat},{lon};{lat},{lon};{lat},{lon}...`\n + `{lat}` - Latitude\n + `{lon}` - Longitude\n - Example: `polygon:52.416,13.082;52.626,13.628;52.916,13.482` - Polygon in Berlin\n 2) As [Flexible Polyline](https://github.com/heremaps/flexible-polyline) Encoding.\n - Support only 2D polyline (without `elevation` specified).\n - Format: `polygon:{encoded_polyline}`\n + `{encoded_polyline}` - encoded [Flexible Polyline](https://github.com/heremaps/flexible-polyline)\n - Example: `polygon:BF05xgKuy2xCx9B7vUl0OhnR54EqSzpEl-HxjD3pBiGnyGi2CvwFsgD3nD4vB6e`\n* Corridor - A polyline with a specified radius (integer, in meters) that defines width of corridor area.\n Possible formats:\n 1) As a list of geopoints that defines a polyline and a radius that defines an area around the polyline.\n - Format: `corridor:{lat},{lon};{lat},{lon};{lat},{lon}...;r={radius}`\n - Example: `corridor:52.416,13.082;52.626,13.628;52.916,13.482;r=1000`\n 2) As [Flexible Polyline](https://github.com/heremaps/flexible-polyline) encoding and a radius that defines an area around the polyline.\n - Supports only 2D polyline (without `elevation` specified).\n - Format: `corridor:{encoded_polyline};r={radius}`\n + `{encoded_polyline}` - encoded [Flexible Polyline](https://github.com/heremaps/flexible-polyline)\n - Example: `corridor:BF05xgKuy2xCx9B7vUl0OhnR54EqSzpEl-HxjD3pBiGnyGi2CvwFsgD3nD4vB6e;r=1000`\n\n* Exception - area to exclude from avoidance. Any area type can be specified. Any area type can be used as an exception. Multiple exceptions can be specified for each area.\n - Format: `{area to avoid/exclude}!exception={area}`\n - Example: `bbox:13.082,52.416,13.628,52.626!exception=polygon:BF05xgKuy2xCx9B7vUl0OhnR54EqSzpEl-HxjD3pBiGnyGi2CvwFsgD3nD4vB6e!exception=bbox:13.082,52.416,13.628,52.626`\n\n Notes:\n * Maximum count of avoided and excluded polygons and corridors is 20.\n * Maximum total count of avoided and excluded bounding boxes, polygons, corridors, including exceptions, is 250.\n * Minimum count of coordinates in one polygon is 3\n * Minimum count of coordinates in any single corridor is 2.\n * Maximum count of coordinates in one polygon or in one corridor is 100\n * The polygon is closed automatically, there is no need to duplicate the first point as the last one.\n * Self-intersecting polygons are not supported.\n","type":"string"},"AttributionLinkType":{"description":"Attribution link type.\n\n* `disclaimer` - Page with further legal information from the agency.\n* `tariff` - Page with information on the tariff.\n","type":"string","enum":["disclaimer","tariff"]},"AxleGroupWeight":{"type":"object","description":"Contains the maximum allowed weight for an axle-group.\n","properties":{"maxWeight":{"description":"Maximum weight of the axle-group-weight restriction, in kilograms.","type":"integer","format":"int32","minimum":0},"axleGroup":{"description":"Extensible enum: `single` `tandem` `triple` `quad` `quint` `...` \nAxle-group associated with the restriction.\n\nPossible values are:\n\n* single\n* tandem\n* triple\n* quad\n* quint\n","type":"string","x-extensible-enum":["single","tandem","triple","quad","quint"]}}},"BaseNoticeDetail":{"type":"object","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"}},"required":["type"]},"BoundingBoxArea":{"type":"object","description":"A bounding box defined by two longitudes and two latitudes.","required":["type","north","south","west","east"],"properties":{"type":{"type":"string","example":"boundingBox"},"north":{"description":"Latitude in WGS-84 degrees of the northern boundary of the box.","type":"number","minimum":-90,"maximum":90,"example":30},"south":{"description":"Latitude in WGS-84 degrees of the southern boundary of the box.","type":"number","minimum":-90,"maximum":90,"example":30},"east":{"description":"Longitude in WGS-84 degrees of the eastern boundary of the box","type":"number","minimum":-180,"maximum":180,"example":30},"west":{"description":"Longitude in WGS-84 degrees of the western boundary of the box.","type":"number","minimum":-180,"maximum":180,"example":30}}},"CO2Emission":{"type":"number","description":"Estimation of the carbon dioxide emission for the given route section. Unit is kilograms with precision to three decimal places.\n\nDefinitions:\n\n* Total Emission (Well-to-Wheel) = Production Emission (Well-to-Tank) + Operational Emission (Tank-to-Wheel)\n* CO2 Equivalent Emission (CO2e for CH4, N2O, etc.) = Gas Emission * Global Warming Potential (GWP)\n\n**Notes:**\n\n* This value represents the operational (tank-to-wheel) carbon dioxide emission.\n* This value represents only the carbon dioxide emission and does not represent the carbon dioxide equivalent emission for other gases or particulates.\n"},"ChargePointOperator":{"type":"object","description":"Information about the charging station charge-point-operator","properties":{"id":{"description":"Charging station charge-point-operator ID.\n","type":"string"},"name":{"description":"Charge-point-operator name","type":"string"}}},"ChargingConnectorType":{"description":"Extensible enum: `iec62196Type1Combo` `iec62196Type2Combo` `chademo` `tesla` `saeJ3400` `gbtDc` `unknown` `...` \nCurrently supported connector types are:\n* `iec62196Type1Combo`: Type 1 Combo connector, commonly called \"CCS1\"\n* `iec62196Type2Combo`: Type 2 Combo connector, commonly called \"CCS2\"\n* `chademo`: CHAdeMO connector\n* `tesla`: North American Charging Standard (NACS) connector. This connector type is deprecated. Return value used instead of `saeJ3400` when the user specifies the deprecated value `tesla` in `ev[connectorTypes]`\n* `saeJ3400`: North American Charging System (NACS) connector\n* `gbtDc`: GB/T Guobiao GB/T 20234.3 DC connector\n* `unknown`: Connector type is not known, e.g., if station is provided by user in request\n","type":"string","x-extensible-enum":["iec62196Type1Combo","iec62196Type2Combo","chademo","tesla","saeJ3400","gbtDc","unknown"]},"ChargingStationBrand":{"type":"object","description":"Information regarding the charging station brand","properties":{"name":{"description":"Charging station brand name","type":"string"},"hrn":{"description":"Charging station brand unique ID.\nIf specified in `ev[preferredBrands]` parameter\nthen it would apply preference to adding stations of the given brand.\n\n**NOTE:** As of now it is generated as a brand name hash.\n","type":"string"}}},"ChargingSupplyType":{"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","type":"string","x-extensible-enum":["acSingle","acThree","dc"]},"Color":{"type":"string","pattern":"#[0-9A-Fa-f]{6}","example":"#FF0000"},"Consumption":{"type":"number","description":"Energy or fuel consumption.\nFor EV energy consumption is in kilowatt hours (kWh). For fuel-based vehicles fuel consumption is in Liters (L) for diesel, petrol and LPG vehicles, and Kilograms (kg) for CNG vehicles.\n"},"ConsumptionModel":{"description":"Extensible enum: `empirical` `physical` `...` \nSpecifies which of the EV consumption models is being used. See the `ev` parameter for details on the models.\n\n* `empirical`\n* `physical`\n","type":"string","default":"empirical","x-extensible-enum":["empirical","physical"]},"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,,,,...,,\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.\n\n* Unit for EV:\n| Vehicle Type | Unit |\n|--------------|------|\n| Electric | Wh/m i.e., Watt-hours per meter|\n\n* Units for Fuel-based vehicles:\n| Vehicle Type | Unit |\n|--------------|------|\n| Diesel, Petrol & LPG | ml/m i.e., milliliters per meter|\n| CNG | gm/m i.e., grams per meter|\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"},"ConsumptionType":{"description":"Extensible enum: `electric` `diesel` `petrol` `lpg` `cng` `lng` `ethanol` `propane` `hydrogen` `...` \nVehicle consumption type. The energy or fuel consumption type (electric, diesel, petrol, lpg, cng, etc.)\nof a vehicle which provides the relevant information required to parse (unit, etc.) the energy or fuel\n`consumption` value of a vehicle.\n","type":"string","x-extensible-enum":["electric","diesel","petrol","lpg","cng","lng","ethanol","propane","hydrogen"]},"Coordinate":{"type":"object","required":["lat","lng"],"properties":{"lat":{"type":"number","format":"double","description":"Latitude in WGS-84 degrees."},"lng":{"type":"number","format":"double","description":"Longitude in WGS-84 degrees."}},"example":{"lat":52.53787,"lng":13.40896}},"CountryCode":{"description":"ISO-3166-1 alpha-3 code","type":"string","example":"FRA","minLength":3,"maxLength":3},"CustomizationHRN":{"description":"HERE Resource Name identifier for customization. This HRN must follow a convention below: hrn:here::::custom::.","type":"string","pattern":"^hrn:here:[a-z]+::[a-z|-]+:custom:[a-z|-]+$","example":"hrn:here:routing::olp-abc:custom:extension-map:abc-yard-routing"},"DataVersion":{"type":"object","description":"Version of a specific data set","properties":{"name":{"type":"string","description":"Identifies a data set, for example, a HRN, or a service specific identifier","example":"optimized-map-for-routing"},"version":{"type":"string","description":"The current version of this data set","example":"2022.346.5.48"}},"required":["name","version"]},"Distance":{"type":"integer","minimum":0,"description":"Distance in meters.","example":189},"Driver":{"type":"object","description":"Driver parameters to be used for calculating routes with automatically added\nrest stops.\n","properties":{"schedule":{"type":"string","description":"A comma separated list of duration pairs in seconds. Each pair is two positive non-zero integers.\nThe first specifies the maximum allowed drive duration before stopping to rest, and the second the resting duration before continuing driving.\n\nFormat `driveDuration,restDuration[,driveDuration,restDuration]...`\n\n* driveDuration - duration in seconds, describes maximum driving duration allowed in a route's section\n till the next stop or route end. Minimum value is 240.\n* restDuration - duration in seconds, describes minimum resting duration required before continuing driving\n\nThe routing engine adds necessary stops for rest to fulfill driver work hours requirements.\nIf the route duration exceeds the defined drive-rest sequence the remaining route is added as the last drive section\n(or several sections if there are `via` waypoints on the remaining route) with critical notice `travelTimeExceedsDriverWorkHours`.\n\n**Limitations**:\n* `driver[schedule]` is only supported for `truck`, `bus` and `privateBus` transport modes.\n* `driver[schedule]` is not supported in combination with any of these parameters: `arrivalTime`, `ev[*]`.\n* `driver[schedule]` doesn't support route alternatives. So `alternatives` parameter value is ignored in combination with `driver[schedule]`.\n* Ferry travel, boarding, and deboarding durations are neither considered part of drive duration nor rest duration unless ferry\n travel duration is below 15 minutes. In this case, ferry travel duration is considered as drive duration.\n* Via waypoint stop-durations are neither considered part of drive duration nor rest duration.\n* Routing requires a minimum driving duration (`driveDuration`) of 240 seconds before a rest stop.\n"}}},"Duration":{"type":"integer","description":"Duration in seconds.","example":198},"EMobilityServiceProvider":{"type":"object","description":"Information about E-Mobility Service Provider","properties":{"id":{"description":"E-Mobility Service Provider ID","type":"string"},"name":{"description":"E-Mobility Service Provider name","type":"string"}}},"EVPost":{"type":"object","properties":{"preferredBrands":{"description":"An array of charging station brand IDs. If `makeReachable` is set to `true`, then charging stations from the specified brands\nwill be preferred as potential charging stops, even if this makes the total route duration (travel time plus charging time) longer (up to 15 minutes per charging stop)\n\nExample of a parameter value preferring two charging station brands:\n```\n {\n \"preferredBrands\": [\n \"6e1a148e8ddf06f613599134197b7c1c\",\n \"6211c90a063d36429b599dda79ae85e3\"\n ]\n }\n ```\n","type":"array","items":{"type":"string"},"deprecated":true},"preferredChargePointOperators":{"description":"An array of charge-point-operator identifiers. If `makeReachable` is set to `true`, then charging stations with one\nof the listed charge-point-operator ids will be preferred as potential charging stops, even if this makes the total\nroute duration (travel time plus charging time) longer (up to 15 minutes per charging stop)\n\nExample with two preferred charge-point-operators specified:\n ```\n {\n \"preferredChargePointOperators\": [\n \"1f608648-cca5-11ed-bb1e-42010aa40002\",\n \"1f90fdf0-cca5-11ed-be23-42010aa40002\"\n ]\n }\n ```\n","type":"array","items":{"type":"string"}}}},"EncodedCorridorArea":{"type":"object","description":"A polygon defined as a [Flexible Polyline](https://github.com/heremaps/flexible-polyline) encoded string\nand with a specified radius that defines an area.\n","required":["type","polyline","radius"],"properties":{"type":{"type":"string","example":"encodedCorridor"},"polyline":{"type":"string","description":"[Flexible Polyline](https://github.com/heremaps/flexible-polyline) that defines a supporting structure for a corridor.\nNotes:\n* Support only 2D polyline (without `elevation` specified).\n* Minimum count of vertices in polyline is 2.\n* Maximum count of vertices in polyline is 100.\n","example":"BFoz5xJ67i1B1B7PzIhaxL7Y"},"radius":{"type":"integer","description":"The width in meters of the corridor determines the outline of the polygon.","minimum":1,"maximum":1000}}},"EncodedPolygonArea":{"type":"object","description":"A polygon defined as a [Flexible Polyline](https://github.com/heremaps/flexible-polyline) encoded string.\n\nThe polygon is automatically closed, so repeating the first vertex is not required.\n","required":["type","outer"],"properties":{"type":{"type":"string","example":"encodedPolygon"},"outer":{"type":"string","description":"[Flexible Polyline](https://github.com/heremaps/flexible-polyline) that defines the outline of the polygon.\nNotes:\n* Support only 2D polyline (without `elevation` specified).\n* Minimum count of vertices in polygon is 3.\n* Maximum count of vertices in polygon is 16.\n","example":"BFoz5xJ67i1B1B7PzIhaxL7Y"}}},"ErrorResponse":{"type":"object","description":"Response in case of error","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"}},"required":["title","status","code","cause","action","correlationId"]},"FarePassValidityPeriod":{"type":"object","description":"Specifies a temporal validity period for a pass","properties":{"period":{"description":"Extensible enum: `annual` `extendedAnnual` `minutes` `days` `months` `...` \nSpecifies one of the following validity periods:\n - `annual`: pass is valid from Jan 1 to Dec 31\n - `extendedAnnual`: pass is valid from Jan 1 to Jan 31 of the following year\n - `minutes`: pass is valid for a specified number of minutes See `unit`.\n - `days`: pass is valid for a specified number of days. See `unit`.\n - `months`: pass is valid for a specified number of months. See `unit`.\n","type":"string","x-extensible-enum":["annual","extendedAnnual","minutes","days","months"]},"count":{"description":"Required if period is `minutes`, days` or `months`, it specifies how many of these units are covered by the pass.","type":"integer"}},"required":["period"]},"FuelType":{"description":"Extensible enum: `diesel` `petrol` `lpg` `cng` `lng` `ethanol` `propane` `hydrogen` `...` \nVehicle fuel type. It is mandatory for calculation of consumption and CO2 emission.\n","type":"string","x-extensible-enum":["diesel","petrol","lpg","cng","lng","ethanol","propane","hydrogen"]},"FunctionalClass":{"description":"Functional class defines a hierarchical network used to determine a logical and efficient route. The following classifications are used:\n\n* `1`: Roads that allow for high volume, maximum speed traffic movement between and through major metropolitan areas.\n* `2`: Roads that are used to channel traffic to functional class 1 roads for travel between and through cities in the shortest amount of time.\n* `3`: Roads that intersect functional class 2 roads and provide a high volume of traffic 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 neighborhoods.\n* `5`: Roads with volume and traffic movement below the level of any other functional class.\n","type":"integer","format":"int32","minimum":1,"maximum":5},"Gate":{"description":"Extensible enum: `keyAccess` `permissionRequired` `emergency` `...` \nType of gate crossing.\n","type":"string","x-extensible-enum":["keyAccess","permissionRequired","emergency"]},"HazardousGoodsRestriction":{"description":"Extensible enum: `explosive` `gas` `flammable` `combustible` `organic` `poison` `radioactive` `corrosive` `poisonousInhalation` `harmfulToWater` `other` `...` \nHazardous goods restrictions refer to the limitations and regulations imposed on the transportation of specific types of hazardous materials during a trip. The following categories of hazardous goods are commonly considered:\n\n* `explosive`: Materials that are capable of causing an explosion\n* `gas`: Gas (definition varies from country to country). For details, check [here](https://en.wikipedia.org/wiki/HAZMAT_Class_2_Gases)\n* `flammable`: Materials that are easily ignited and capable of catching fire.\n* `combustible`: Materials that have the potential to burn or catch fire.\n* `organic`: Materials derived from living organisms or containing carbon compounds.\n* `poison`: Substances that can cause harm or death when ingested, inhaled, or absorbed.\n* `radioactive`: Materials that emit radiation and pose potential health risks.\n* `corrosive`: Substances that can cause damage or destruction through chemical reactions.\n* `poisonousInhalation`: Materials that are toxic when inhaled.\n* `harmfulToWater`: Materials that can cause pollution or harm to water bodies.\n* `other`: Other types of hazardous materials not covered by the above categories\n","type":"string","x-extensible-enum":["explosive","gas","flammable","combustible","organic","poison","radioactive","corrosive","poisonousInhalation","harmfulToWater","other"]},"HazardousGoodsRestrictionAny":{"description":"Indicates that all hazardous goods are subject to restrictions during the trip.","type":"string","enum":["any"],"example":"any"},"HovAttributes":{"description":"`hovAttributes` is applied to a span of a route section and indicates the presence of usable HOV lanes on the span.\n\nAdditional HOV-attributes may be supported in the future. When encountering unknown HOV-attributes, e.g., in the software parser, it is recommended to ignore them.\n","type":"object","properties":{"usableHovLane":{"type":"boolean","default":false,"description":"Span has an HOV lane usable by the vehicle for which the route was requested at the\ntime of traversal of the span.\n\n**Notes**:\n- If `allow[hot]` is specified, then lanes that would require toll to be paid to use will be marked with `usableHovLane`.\n- It is not guaranteed that the HOV lane is connected to the route.\n\n**Disclaimer: This parameter is currently in beta release, and is therefore subject to breaking changes.**\n"}}},"LicensePlateRestrictionType":{"description":"Extensible enum: `lastCharacter` `...` \nSpecifies the components of the vehicle license plate\nconsidered for the restriction.\n","type":"string","x-extensible-enum":["lastCharacter"]},"LocalizedString":{"type":"object","description":"String with optional language code.","properties":{"value":{"description":"String written in the language specified in the language property.","type":"string"},"language":{"description":"Language in BCP47 format","type":"string"}},"required":["value"],"example":{"value":"Invalidenstraße","language":"de"}},"Location":{"type":"object","description":"Location on the Earth","properties":{"lat":{"description":"Location of a point on the Earth north or south of the equator in decimal degrees.","type":"number","format":"double","example":52.531677},"lng":{"description":"Location of a place on the Earth east or west of the prime meridian in decimal degrees.","type":"number","format":"double","example":13.381777},"elv":{"description":"Ellipsoid(geodetic) height in meters. Difference between the WGS84 ellipsoid and a point on the Earth’s surface.\nNote: Similar elevation can be obtained from a GPS receiver.\n","type":"number","example":512.5}},"example":{"lat":52.531677,"lng":13.381777},"required":["lat","lng"]},"MatchTracePoint":{"type":"object","description":"GPS probe point with parameters relevant to path or route matching","properties":{"lat":{"description":"Latitude in degrees","type":"number","format":"double"},"lng":{"description":"Longitude in degrees","type":"number","format":"double"}},"required":["lat","lng"]},"MaxSpeed":{"description":"Speed in meters per second, or \"unlimited\" indicating that the speed is unlimited, e.g., on a German autobahn","oneOf":[{"type":"number","minimum":0},{"type":"string","enum":["unlimited"]}]},"MaxSpeedOnSegment":{"type":"string","description":"A comma separated list of segments with restrictions on maximum baseSpeed.\n\nEach entry has the following structure:\n`{segmentId}(#{direction})?;speed={maxBaseSpeed}`\n\nThe individual parts are:\n* segmentId: The identifier of the referenced topology segment inside the catalog, example: `here:cm:segment:207551710`\n* direction (optional): Either '*' for bidirectional (default), '+' for positive direction, or '-' for negative direction\n* maxBaseSpeed: New value in m/s of baseSpeed on segment\n\nExample of a parameter value excluding two segments:\n`here:cm:segment:207551710#+;speed=10,here:cm:segment:76771992;speed=1`\n\n**Notes**:\n- It does not increase default baseSpeed on segment. If the value is greater than the default base speed, then such penalty will have no effect.\n- Minimum valid value for speed is 1\n- Using segments with a modified base speed does not trigger any notifications\n- Maximum number of penalized segments in one request cannot be greater than 1000.\n \"penalized segments\" refer to segments that have a restrictions on maximum baseSpeed with `maxSpeedOnSegment`\n or avoided with `avoid[segments]`\n- In case the same segment is penalized multiple times through values provided in the query string and/or the POST body,\n then the most restrictive value will be applied.\n"},"MaxSpeedOnSegmentPost":{"type":"array","items":{"type":"object","properties":{"segment":{"type":"string","description":"Identifier of the segment with restrictions on maximum `baseSpeed`.\n\nEach entry has the following structure:\n`{segmentId}(#{direction})?`\n"},"speed":{"type":"number","minimum":1,"maximum":70,"description":"Maximum `baseSpeed` on segment in m/s.\n"}}},"description":"Segments with restrictions on maximum `baseSpeed`.\n\nFor the general description of the functionality please refer to the `maxSpeedOnSegment` parameter of the\nquery string.\n\nPassing parameters in the POST body is suggested when the length of the parameters exceeds the\nlimitation of the GET request.\n\nExample of a parameter value excluding two segments:\n```\n[\n {\n \"segment\": \"here:cm:segment:207551710#+\",\n \"speed\": 10\n },\n {\n \"segment\": \"here:cm:segment:76771992\",\n \"speed\": 1\n }\n]\n```\n\n**Notes**:\n- Maximum number of penalized segments in one request cannot be greater than 1000.\n \"penalized segments\" refer to segments that have a restrictions on maximum baseSpeed with `maxSpeedOnSegment`\n or avoided with `avoid[segments]`.\n- In case the same segment is penalized multiple times through values provided in the query string and/or the POST body,\n then the most restrictive value will be applied.\n"},"NetworkRestrictedTruck":{"description":"A truck transport mode with additional restrictions on the road networks that can be used for routing. The road networks are defined via the `permittedNetworks` parameter.\n","type":"object","properties":{"permittedNetworks":{"description":"**Disclaimer: This parameter is currently in beta release, and is therefore subject to breaking changes.**\n\nSpecifies a list of road networks permitted to be used. These road networks are considered mandatory and will be used as much as possible.\n\nA pipe-separated list of colon-separated country, state, and road network codes.\n\nThe general format of each entry is `{country}:{state}[,state]...:{network}[,network]...`, where\n + `{country}` - Country code according to (ISO 3166-1 alpha-3)\n + `{state}` - State code part according to (ISO 3166-2)\n + `{network}` - Network code according to the information below\n\nFor countries with only countrywide networks, the state part is omitted, and the format is simply `{country}:{network}[,network]...`.\n\nThe maximum number of entries is 100.\nThe maximum number of states per entry is 8.\nThe maximum number of networks per entry is 15.\n\nThe table below specifies the currently supported networks. In case a network is defined countrywide, the `State` column shows `N/A`:\n\n| Country | State | Network codes |\n| ------- | ----- | ----------------------------------------------------------------------------------------------------- |\n| AUS | ACT | bDouble26Gml, bDouble26Hml, pbs2A |\n| AUS | NSW | bDouble19, bDouble23Gml, bDouble26Gml, bDouble26Hml, bTripleGml, pbs2A |\n| AUS | NT | bDouble26Hml, bTripleGml |\n| AUS | QLD | bDouble23Gml, bDouble23Hml, bTripleGml, bTripleHml, pbs2A, pbs3A, pbs3B, pbs4A |\n| AUS | SA | bDouble23Gml, bDouble23Hml, bDouble26Gml, bDouble26Hml, bTripleGml, pbs2A, pbs2B, pbs3A, pbs3B, pbs4A |\n| AUS | TAS | bDouble23Gml, bDouble26Gml, bDouble26Hml, pbs2A, pbs2B |\n| AUS | VIC | bDouble26Gml, bDouble26Hml, bTripleGml, pbs2A, pbs2B |\n| AUS | WA | bDouble27Dot5, bTripleGml, pbs2B, pbs3B |\n| NZL | N/A | fiftyMax, hpmv |\n","type":"string","example":"NZL:hpmv,fiftyMax|AUS:NSW:bDouble23Gml,bTripleGml|AUS:NSW,QLD:pbs2A|AUS:NSW,VIC:bDouble26Hml,pbs2A"}},"required":["permittedNetworks"]},"NoticeSeverity":{"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","type":"string","enum":["critical","info"]},"ParkingLotPlaceType":{"description":"Extensible enum: `parkAndRide` `...` \nCurrently possible values are:\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","type":"string","x-extensible-enum":["parkAndRide"]},"PartialTime":{"type":"string","description":"**RFC 3339**, section 5.6 as defined by `partial-time`.","pattern":"^[012]\\d:[0-5]\\d:[0-6]\\d(\\.\\d+)?$","example":"08:30:00"},"PaymentMethod":{"description":"Extensible enum: `cash` `bankCard` `creditCard` `passSubscription` `transponder` `videoToll` `cashExact` `travelCard` `...` \nRecognized methods of payment.\n","type":"string","x-extensible-enum":["cash","bankCard","creditCard","passSubscription","transponder","videoToll","cashExact","travelCard"]},"PedestrianSpeed":{"description":"Pedestrian speed in meters per second","type":"number","minimum":0.5,"maximum":2,"default":1},"PermittedNetworks":{"description":"** Disclaimer: This object is currently in beta release, and is therefore subject to breaking changes.**\nThis span contains information about the `networkRestrictedTruck` tranport mode related networks.\n\n**Note:** Only supported in `networkRestrictedTruck` (Beta) transport mode.\n","type":"object","properties":{"offPermittedNetworks":{"description":"Indicates that the span is not covered by any of the networks specified in the `permittedNetworks` parameter.","type":"boolean","default":false}}},"Polyline":{"type":"string","description":"Line string in [Flexible Polyline](https://github.com/heremaps/flexible-polyline) format. Coordinates are in the WGS84 coordinate system, including `Elevation` (if present).","example":"A05xgKuy2xCx9B7vUl0OhnR54EqSzpEl-HxjD3pBiGnyGi2CvwFsgD3nD4vB6e"},"RailwayCrossing":{"description":"Extensible enum: `protected` `unprotected` `unknown` `...` \nType of railway crossing.\n","type":"string","x-extensible-enum":["protected","unprotected","unknown"]},"RefReplacements":{"description":"Dictionary of placeholders to replacement strings for the compact representation of map entity references.\n","type":"object","additionalProperties":{"type":"string"}},"ReroutingMode":{"description":"Defines what kind of additional route calculation should be done.\n\n* `none` - Cuts off route before the current position. Updates dynamic attributes of the\nroute after the current position. If the current position, i.e., the new `origin`, is defined and is\noutside of the original route then the request will fail. If both `origin` and\n`lastTraveledSectionIndex` or `traveledDistanceOnLastSection` are provided then\n`lastTraveledSectionIndex` and `traveledDistanceOnLastSection` will be applied first, and\nthen `origin` will be matched to the part of the route that's left. This is the default behavior.\n* `returnToRoute` - Same as `none` if current position is on the route. If the current\nposition is not on the original route then a new route to the destination will be\ncalculated, starting from the current position. The new route will try to preserve the shape\nof the original route, if possible. If a new optimal route is found before a route back to\nthe original route then the new route will be returned.\n","type":"string","enum":["none","returnToRoute"]},"Return":{"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](https://github.com/heremaps/flexible-polyline) Encoding.\n Either a 2D polyline (without `elevation` specified), or a 3D polyline with the 3rd dimension type `Elevation` (with `elevation` specified), using the WGS84 coordinate system.\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` - (Deprecated) No longer returns a value. The parameter is still accepted for backwards compatibility.\n* `typicalDuration` - Include route duration under typical traffic conditions.\n* `elevation` - Include WGS84 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 Returned incidents may be referenced by `incidents` and/or `intersectionIncidents` span parameters.\n Incidents are localized to the requested language.\n* `routingZones` - Include information about routing zones each section goes through.\n* `truckRoadTypes` - Include information about road types each section goes through.\n* `tolls` - Include information about the tolls to be paid, per section, according to the `tolls` parameter and other toll-influencing\n parameters such as vehicle dimensions in the query,\n e.g `transportMode`, `vehicle[hovOccupancy]`, vehicle[height]. Check the Developer Guide for tutorials on the topic.\n If tolls cannot be calculated for a section, it will contain the `tollsDataUnavailable` notice code.\n\n **Note**:\n - Toll requests support `car` dimensions such as atypical car height and weight, trailers, axle count and vehicle fuel type. However extreme parameter combinations may result in tolls being returned for a different vehicle type (for example, a car with 6 axles will most likely result in truck tolls).\n Therefore the request will return the most \"typical\" toll cost for the parameters provided.\n - Tolls are not available in route import service. See [this tutorial](https://docs.here.com/routing/docs/routing-v8-tolls-routeimport) for information on how to request tolls when using route import.\n* `routeLabels` - Include a list of the most important names and route numbers on this route that differentiate it from other alternatives\n* `potentialTimeDependentViolations` - Include info notices for potential time-dependent violations in the sections that match the current vehicle profile, but are not violating the restricted times for the calculated route.\n* `noThroughRestrictions` - Include information about the parts of the route that are not allowed to be driven through, i.e. route can only start, end, or have an intermediate `via` waypoint here.\n\nThe following restrictions apply when specifying the `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","type":"string","enum":["polyline","actions","instructions","summary","travelSummary","mlDuration","typicalDuration","turnByTurnActions","elevation","routeHandle","passthrough","incidents","routingZones","truckRoadTypes","tolls","routeLabels","potentialTimeDependentViolations","noThroughRestrictions"]},"RoadInfoType":{"description":"Type of the road (rural, urban, highway)","type":"string","enum":["rural","urban","highway"],"default":"urban"},"RoundaboutAngle":{"description":"The degree measure of the arc traversed from the roundabout entrance to the exit of the maneuver.\n\nAvailable only for exit roundabout actions. Positive values indicate an exit angle\nfor a right-hand side driving roundabout and negative values indicate an exit angle\nfor a left-hand side driving roundabout.\n","type":"number","format":"double","minimum":-360,"maximum":360,"example":204.83},"RouterMode":{"description":"Mode of transport to be used for route calculation.","type":"string","enum":["car","truck","pedestrian","bicycle","scooter","taxi","bus","privateBus","networkRestrictedTruck"]},"RoutingMode":{"description":"Specifies which optimization is applied during the calculation.\n\n* `fast`: Route calculation from start to destination optimized by travel time. In many\n cases, the route returned by `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 - `privateBus`\n - `scooter`\n - `taxi`\n - `networkRestrictedTruck`\n","type":"string","enum":["fast","short"],"default":"fast"},"RoutingZoneReference":{"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 HERE Resource Name that identifies the source catalog of the routing zone, example: `hrn:here:data::olp-here:rib-2`\n* `catalogVersion`: The catalog version\n* `layerId` (optional): The layer inside the catalog where the routing zone is located, example: `environmental-zones`\n* `tileId`: The HERE 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, example: `here:cm:envzone:3455277`\n\nExample of a reference to an environmental zone in standard form:\n`hrn:here:data::olp-here:rib-2:1557:environmental-zones:all:here:cm:envzone:3455277`\n\nIn order to reduce response 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 colons 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```\n\"refReplacements\": {\n \"0\": \"hrn:here:data::olp-here:rib-2:1557\",\n \"1\": \"environmental-zones:all:here:cm:envzone\"\n}\n```\n","type":"string"},"Scooter":{"type":"object","description":"Scooter-specific parameters","properties":{"allowHighway":{"description":"Specifies whether the scooter is allowed on the highway or not. This parameter is optional. If not provided, the scooter is not allowed to use the highway by default. There is a similar parameter avoid[features]=controlledAccessHighway to disallow highway usage. avoid[features] takes precedence, so if this parameter is also used, scooters are not allowed to use highways even if `allowHighway` is set to `true`.","type":"boolean","default":false}}},"SegmentRef":{"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 HERE Resource Name that identifies the source catalog of the segment, example: hrn:here:data::olp-here:rib-2\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 HERE 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 HERE tile key is indicated by the position of the highest set bit in binary representation. Since the HERE 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 hexadecimal digit. For example, the level 14 tile 377894441 is included in the level 12 tile 23618402 (37789444110 = 1686362916 → 168636216 = 2361840210)\n* segmentId: The identifier of the referenced topology segment inside the catalog, example: here:cm:segment:84905195\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:\nhrn:here:data::olp-here:rib-2:1363::377894441:here:cm:segment:84905195#+0.7..1\n\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 needs to be surrounded by colons 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\"refReplacements\": {\n \"0\": \"hrn:here:data::olp-here:rib-2:1363:\",\n \"1\": \"here:cm:segment\"\n}\n","type":"string"},"SimpleErrorResponseSchema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error"},"error_description":{"type":"string","description":"Human-readable error description"}}},"Spans":{"type":"string","enum":["walkAttributes","streetAttributes","carAttributes","truckAttributes","scooterAttributes","names","length","duration","baseDuration","typicalDuration","countryCode","stateCode","functionalClass","routeNumbers","speedLimit","maxSpeed","dynamicSpeedInfo","segmentId","segmentRef","consumption","routingZones","truckRoadTypes","notices","incidents","tollSystems","gates","railwayCrossings","noThroughRestrictions","hovAttributes","permittedNetworks"]},"Speed":{"description":"Speed in meters per second","type":"number","minimum":0},"StateCode":{"description":"The second part of an ISO-3166-2 code (e.g., `TX` from `USA-TX`) consists of up to three alphanumeric characters.\nIt is used to identify the principal subdivisions (e.g., provinces or states) of a country in conjunction with a CountryCode\n\nNote: State codes may not be available in some countries.\n","type":"string","minLength":1,"maxLength":3},"StreetAttributes":{"description":"Extensible enum: `rightDrivingSide` `dirtRoad` `tunnel` `bridge` `ramp` `motorway` `roundabout` `underConstruction` `dividedRoad` `privateRoad` `controlledAccessHighway` `builtUpArea` `...` \n`StreetAttributes` is applied to a span of a route section and describes attribute flags of a street. The following flags can be assigned:\n* `rightDrivingSide`: Vehicles must drive on the right-hand side of the road in this part of the route.\n* `dirtRoad`: This part of the route has an unpaved surface, such as a gravel or dirt road.\n* `tunnel`: This part of the route passes through a tunnel.\n* `bridge`: This part of the route crosses a bridge.\n* `ramp`: This part of the route is a ramp, typically connecting to or from highways.\n* `motorway`: This part of the route is a controlled access road, typically a highway with motorway signage.\n* `roundabout`: This part of the route includes a roundabout.\n* `underConstruction`: This part of the route is currently under construction.\n* `dividedRoad`: This part of the route uses a road with a physical or legal divider in the middle, separating opposing traffic flows.\n* `privateRoad`: This part of the route uses a privately owned road.\n* `controlledAccessHighway`: This part of the route is either a controlled access road, limited access road, or both.\n* `builtUpArea`: This part of the route most likely passes through a built-up area.\n\nIt is possible that new street attributes may be supported in the future. When encountering unknown street attributes, e.g., in the software parser, it is recommended to ignore them.\n","type":"string","x-extensible-enum":["rightDrivingSide","dirtRoad","tunnel","bridge","ramp","motorway","roundabout","underConstruction","dividedRoad","privateRoad","controlledAccessHighway","builtUpArea"]},"Taxi":{"type":"object","description":"Taxi-specific parameters","properties":{"allowDriveThroughTaxiRoads":{"description":"Specifies if a vehicle is allowed to drive through taxi-only roads and lanes. Even if\nthis option is set to `false`, the vehicle is still allowed on taxi-only roads at the\nstart of the route and at the destination.\n","type":"boolean","default":true}}},"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"},"TimeDomain":{"description":"Specifies date and time period during which the restriction applies. Value is a string in the Time\nDomain format. Time Domain is part of the GDF (Geographic Data Files) specification, which is an ISO standard.\nCurrent standard is GDF 5.1 which is [ISO 20524-1:2020](https://www.iso.org/standard/68244.html).\n\nFor a detailed description of the Time Domain specification and usage in routing services, please refer to\nthe documentation available in the [Time Domain](https://docs.here.com/routing/docs/routing-v8-time-domain-basics) page of the Developer Guide.\n","type":"string","example":"-(d1){w1}(d3){d1}"},"TimeRestrictedWeekdays":{"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"},"TollSystem":{"type":"object","description":"Information about a toll system collecting payments on the route.\n","properties":{"id":{"description":"The internal identification of this toll system. It will be replaced in the future by an HRN (HERE Resource Name) identifier.\n","type":"integer","deprecated":true},"name":{"description":"The name of this toll system\n","type":"string"}}},"Tolls":{"type":"object","description":"Vehicle-independent options that may affect route toll calculation as well as options\naffecting the output of the tolls, such as summaries.\n\nSince this parameter controls behaviour related to tolls in the return part of the response,\nuse of this parameter requires `return=tolls` to be selected.\n","properties":{"transponders":{"description":"Certain toll systems allow users to pay for the usage of the corresponding tollroads using transponders.\nAs the price that the user pays with a transponder could be different from other payment methods for accessing the same toll roads\nthis is provided to allow the user to specify the transponders that they have.\nIf a toll system requires a certain transponder to access it and the user states that they have it,\nthe price for payment with transponders will be used when reporting fare prices\nand for summaries, if required by the `tolls[summaries]` parameter.\n\nThe value of the parameter is a comma-separated list of transponder systems that the user has. Alternatively,\nthe user can also specify `all` as a list element to state they have all required transponders along any potential route.\n\n**Note**: Currently, the only valid value is `all`.\n","type":"string"},"vignettes":{"description":"This parameter allows the user to specify for which toll roads the user has valid vignettes.\nIf a road requires a certain vignette and the user states that they have it, no notices will be\ngiven regarding the requirement to have it.\n\nThe value of the parameter is a comma-separated list of vignettes that the user has. Alternatively,\nthe user can also specify `all` as a list element to state they have all required vignettes along any potential route.\n\nNo toll costs information will be returned for a given road requiring a vignette if the user states\nthey already have it, as no further payment is necessary. If `tolls` are requested for spans, the toll\nsections for these types of toll systems are still reported, nevertheless.\n\n**Note**: Currently, the only valid value is `all`.\n","type":"string"},"summaries":{"description":"Items extensible enum: `total` `tollSystem` `country` `...` \nThis parameter allows the user to specify criteria for tolls aggregation.\nMultiple values may be requested at once.\nToll aggregation is performed at the section level only.\n\nPossible values are:\n - `total`: the user wants a single value summarizing the tolls to be paid in the section.\n This summary criterion requires that a `currency` has been passed as a parameter, to group\n multi-currency roads together, even if the route would traverse roads that use only one currency;\n see `currency` parameter.\n - `tollSystem`: toll costs are aggregated per toll system.\n - `country`: toll costs are aggregated per country.\n\nNote that any toll instance may have multiple prices, depending on factors such as time of day,\npayment methods, etc. that are not available in the request. As a result,\nthe most economical value is selected for summary calculation, so summaries should be considered\ninformative only.\n","type":"array","items":{"type":"string","x-extensible-enum":["total","tollSystem","country"]}},"vehicleCategory":{"type":"string","description":"Extensible enum: `minibus` `...` \nDefines special toll vehicle types. Usual types like car or truck are determined from transport mode.\n\n| category | Description |\n| --------- | ------- |\n| minibus | Commercial buses with a seating capacity of 16-25 passengers (NA) or a small bus that is used to transport a maximum of 15 passengers. Can be used only with transport mode `car` |\n\n**NOTE:** It can be extended by other vehicle categories in the future.\n","x-extensible-enum":["minibus"]},"emissionType":{"description":"Defines the emission types and CO2 emission classes as defined by the toll operator.\nThe emission types defined are based on the Emission standards. Emission types are only published when the toll cost is defined based on emission type classes.\n\n## Format\n\nFormat: `EmissionType[CO2EmissionClass]`\n\n`EmissionType` is specified as `euro6`, `euro5`, etc. Allowed values are `[euro1, euro2, euro3, euro4, euro5, euro6, euroEev]`.\n\n`CO2EmissionClass` is optional and is specified as `;co2class=1`, `;co2class=2`, etc. Allowed values for `co2class` are `[1, 2, 3, 4, 5]`.\n\n## Examples:\n\nOnly toll emission type (euro6), without CO2 emission class: `euro6`\n\nToll emission type (euro6) with CO2 emission class (class1): `euro6;co2class=1`\n\n**NOTES:**\n* For EV routing (i.e., any `ev` namespace parameter is specified in the request or `vehicle[engineType]=electric` is specified): when not specified, the appropriate emission type and CO2 emission class are automatically inferred.\n* For cases other than EV routing: when not specified, `EmissionType` defaults to `euro5`. If `EmissionType` is provided without a `co2class`, then `co2class` defaults to `1`.\n* Providing only a `CO2EmissionClass` without an `EmissionType` is not supported, i.e. `euro6;co2class=1` is valid but `co2class=1` is invalid.\n* Providing an invalid combination of `EmissionType` and `CO2EmissionClass` as input may result in unexpected tolls.\n","type":"string","example":"euro6"}}},"Traffic":{"type":"object","description":"Traffic specific parameters.","properties":{"overrideFlowDuration":{"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","type":"integer"},"mode":{"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","type":"string","default":"default","enum":["default","disabled"]}}},"TrafficIncidentCriticality":{"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","type":"string","enum":["critical","major","minor","low"]},"TrafficIncidentType":{"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","type":"string","x-extensible-enum":["accident","congestion","construction","disabledVehicle","massTransit","plannedEvent","roadHazard","roadClosure","weather","laneRestriction","other"]},"TrailerCountRange":{"type":"object","description":"Constrains the restriction to vehicles with the number of trailers within the specified range.","properties":{"from":{"description":"Inclusive minimum of trailer count.","type":"integer","format":"int32","minimum":0},"to":{"description":"Inclusive maximum of trailer count. If not set, the maximum trailer count is unbounded.","type":"integer","format":"int32","minimum":0}}},"TransitIncidentEffect":{"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","type":"string","x-extensible-enum":["cancelledService","reducedService","additionalService","modifiedService","delays","detour","stopMoved","other"]},"TransitIncidentType":{"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","type":"string","x-extensible-enum":["technicalProblem","strike","demonstration","accident","holiday","weather","maintenance","construction","policeActivity","medicalEmergency","other"]},"TransitStopAttributes":{"description":"Extensible enum: `noEntry` `noExit` `...` \nAttributes of a stop.\n\n* `noEntry`: The transport cannot be entered at the stop.\n* `noExit`: The transport cannot be exited at the stop.\n","type":"string","x-extensible-enum":["noEntry","noExit"]},"TransponderSystem":{"description":"Transponder system for which a fare is applicable.","type":"object","properties":{"system":{"type":"string","description":"Transponder system name."}}},"TruckAxleCountRange":{"type":"object","description":"Constrains the restriction to trucks with the number of axles within the specified range.","properties":{"from":{"description":"Inclusive minimum of axle count.","type":"integer","format":"int32","minimum":2},"to":{"description":"Inclusive maximum of axle count. If not set, the maximum axle count is unbounded.","type":"integer","format":"int32","minimum":2}}},"TruckType":{"description":"Specifies the type of the 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 (also known as a semi-truck).\n","deprecated":true,"type":"string","enum":["Straight","Tractor"]},"TunnelCategory":{"description":"Specifies the tunnel category used to restrict the transport of specific goods.\n","type":"string","enum":["B","C","D","E"]},"TurnActionDirection":{"description":"Direction of the turn. `middle` is only used by the `keep` action.","type":"string","enum":["middle","right","left"]},"TurnActionSeverity":{"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","type":"string","enum":["light","quite","heavy"]},"TurnAngle":{"description":"The angle of the turn expressed in degrees.\n\nIt is available only for turn-by-turn actions. A positive number indicates a clockwise angle.\n","type":"number","format":"double","minimum":-180,"maximum":180,"example":-132.28},"Units":{"description":"Units of measurement used, for example, in guidance instructions. The default is `metric`.","type":"string","enum":["metric","imperial"]},"Uri":{"description":"An URL address that links to a particular resource.","type":"string","format":"uri","example":"https://url.address.com/resource"},"VehicleRestrictionMaxWeight":{"type":"object","description":"Contains the maximum permitted weight, specified in kilograms, along with the specific type of the maximum permitted weight restriction.\n","properties":{"value":{"type":"integer","format":"int32","minimum":0},"type":{"description":"Extensible enum: `empty` `gross` `current` `unknown` `...` \nRepresents the specific type of the maximum permitted weight restriction.\n* `empty`: Restriction is for empty weight of the vehicle combination.\n* `gross`: Restriction is for gross weight.\n* `current`: Restriction is for current weight.\n* `unknown`: Restriction may apply to gross or current weight. Specific `type` data for the restriction is not available.\n\n**NOTES:**\n* A restriction of type `unknown` may change to `gross` or `current` when data becomes available in future.\n* A restriction of type `gross` or `current` may also change to a different type if actual regulation changes.\n","type":"string","x-extensible-enum":["empty","gross","current","unknown"]}}},"VehicleType":{"description":"Specifies the type of the vehicle\n\n* `StraightTruck`: A truck on a single frame with a permanently attached cargo area. **Note:**\ndefault value when truck routing mode is used.\n* `Tractor`: A towing vehicle that can pull one or more semi-trailers (also known as a semi-truck).\n\n**Limitations:** only valid for `transportMode=truck`.\n","type":"string","enum":["StraightTruck","Tractor"]},"WalkAttributes":{"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 traversed if origin, destination or any via waypoint is located there.\n* `tollRoad`: This part of the route is restricted with a fee (or toll).\n\nIt is possible that new attributes may be supported in the future. When encountering unknown attributes, e.g., in the software parser, it is recommended to ignore them.\n","type":"string","x-extensible-enum":["stairs","park","indoor","open","noThrough","tollRoad"]},"Waypoint":{"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`. Option cannot be combined with `radius`, `radiusPenalty` or `snapRadius`.\n* `displayLocation`: `{lat},{lng}`. Indicates the physical location of the POI. It is different from the originalLocation and location which are generally expected to be on the navigable road network, i.e., on segments.\n* `uTurnPermission`: enum `[allow, avoid]`. Specifies the U-Turn Permission mode at the stop-over waypoint. If unspecified, the permission will be determined by the global setting, avoid[features]=uTurns. This feature is not supported for pass-through waypoints and U-Turns are generally avoided in that case.\n + `allow` : Allow making a U-Turn at this stop-over waypoint\n + `avoid` : Avoid making a U-Turn at this stop-over waypoint\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. Sets the radius within which all locations are considered equally eligible for selection as waypoints. Typical use cases include scenarios with imprecise coordinates or user input provided on low resolution map displays. The value is capped at 200 meters. Setting a higher value doesn't return an error. Can't be used with `snapRadius`.\n* `snapRadius`: int, meters. Sets the radius within which waypoints are matched to the most \"significant\" place. Candidates for matching are sorted in the order of significance which is based on the visibility on a zoomed-out map. A highway is considered more significant than a national road, while a national road is more significant than a city road. Typical use case - selecting waypoints on a zoomed-out view of a map on a drag-and-drop interface, where only significant roads are visible. A big enough radius allows to match waypoints to such roads. Can't be used with `radius` or `radiusPenalty` parameters.\n* `radiusPenalty`: int, percentage 0-10000. Penalty as percentage: Used in conjunction with the `radius` parameter. Router will match the waypoint within the specified radius and apply a penalty to candidates based on their air distance to the waypoint. This penalty is proportional to the given percentage, where 100 is just the cost of the air distance, and 200 is twice the cost of the air distance. The penalty must be chosen so that, when multiplied by the radius, the result is less than or equal to 7200. Regardless, only values up to and including 10000 will be accepted. This means that a maximum penalty of 3600% is allowed for a radius of 200m, 7200% for 100m and 10000% for 72m and less. Higher values will result in an error response. `radiusPenalty` cannot be combined with `snapRadius`. **Alpha**: This parameter is in development. It may not be stable and is subject to change.\n\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. Values greater than 2000 meters will be capped at 2000 meters.\n* `segmentIdHint`: string. Causes the router to try and match to the specified segment. Waypoint coordinates need to be on the segment, otherwise waypoint will be matched ignoring the segment hint. This parameter can be used when the waypoint is too close to more than one segment to force matching to a specific one.\n* `onRoadThreshold`: int, meters. allows specifying a distance within which the waypoint could be considered as being on a highway/bridge/tunnel/sliproad. Within this threshold, the attributes of the segments do not impact the matching. Outside the threshold only segments which aren't one of highway/bridge/tunnel/sliproad can be matched.\n\nSupported waypoint options:\n* `stopDuration`: desired duration for the stop, in seconds.\n `stopDuration` must be less than 50000.\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 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* `charging`: Structured string denoting a user-planned charging stop.\n\n Format: `charging=(power=;current=;voltage=;supplyType=;minDuration=;maxDuration=)`.\n\n The properties `power`, `current`, `voltage` and `supplyType` denote the characteristics of the chosen compatible connector at the station. These are all required.\n `minDuration` and `maxDuration` set the time bounds for the charging time. At least one of them is required. For most use cases we recommend to provide at least `minDuration`.\n The following are the specifications for the properties:\n + `power`: value in kW, type: number. Rated power of the connector.\n + `voltage`: value in V, type: number. Rated voltage of the connector.\n + `current`: value in A, type: number. Rated current of the connector.\n + `supplyType`: one of {\"acSingle\", \"acThree\", \"dc\"} for 1-phase AC, 3-phase AC and DC respectively, type: string.\n + `minDuration`: value in seconds, type: int. Minimum time the user expects to charge at the station, including `chargingSetupDuration`.\n + `maxDuration`: value in seconds, type: int. Maximum time the user plans to charge at the station, including `chargingSetupDuration`.\n\n For a user-planned charging stop, the following properties of the `ev` parameter are also required (see documentation for the `ev` parameter):\n + `initialCharge`\n + `maxCharge`\n + `chargingCurve`\n\n *Notes*:\n * This option is only supported for /v8/routes endpoint.\n * This option is not supported for pass-through waypoints.\n * If `makeReachable=true` and `minDuration` is not provided (or if `minDuration=0`), route calculation may suggest not to charge on this station, for example,\n if a better station is available in the vicinity.\n * If `stopDuration` is provided then the total time at the stop is the higher of (`stopDuration`, `chargingSetupDuration` + `chargingDuration`).\n * If charging for `minDuration` would charge above `maxCharge`, the time spent charging is capped by `maxCharge`.\n * If `stopDuration` or `minDuration` exceed `chargingSetupDuration` + `chargingDuration`, the `waiting` post action duration is set to the remaining time.\n * If `makeReachable=true` is not set, the target charge is `maxChargeAfterChargingStation`, unless the charging time would be outside of the specified duration range.\n In such case, the nearest valid value is used.\n * In getRoutesByHandle requests, the target charge from the original route response is used, unless the charging time would be outside of the specified duration range.\n In such case, the nearest valid value is used.\n","type":"string"},"WeightPerAxleGroup":{"description":"Specifies the weights of different axle groups, such as single and tandem axles.\n\nThis allows specification of axle weights in a more fine-grained way than `weightPerAxle`. This\nis relevant in countries with signs and regulations that specify different limits for different\naxle groups, such as the USA and Sweden.\n\nAll axle group weights are evaluated against their respective axle group restrictions and against\ngeneric axle weight restrictions. This means that the provided tandem axle group weight is\ncompared with all tandem axle group weight restrictions and all generic axle weight restrictions.\nThe same is true for single, triple, quad, and quint axle groups.\n\nFormat: `AxleGroup:Weight[,AxleGroup2:Weight2]...`\n\nCurrently, allowed axle-groups are:\n * `single`\n * `tandem`\n * `triple`\n * `quad`\n * `quint`\n\nWeights are specified in kilograms (kg) and represent the total weight of the axle-group.\n\n**Note:** `weightPerAxleGroup` and `weightPerAxle` are incompatible.\n\n**Limitations:** only valid when `transportMode` is one of (`truck`, `bus`, `privateBus`).\n","type":"string","example":"single:11000,tandem:18000"},"WheelchairAccessibility":{"description":"Defines accessibility for people with a disability and who use a wheelchair.\n\n* `unknown` - Information is not available.\n* `yes` - Full unrestricted accessibility.\n* `limited` - Accessibility is limited, not everywhere or require assistance.\n* `no` - No accessibility.\n","type":"string","enum":["unknown","yes","limited","no"],"default":"unknown","example":"unknown"},"Agency":{"type":"object","description":"Contains information about a particular agency.","properties":{"id":{"description":"Unique code of the agency. Specifies if the same agency is used on different sections of the same route.\n\n**NOTE**: The given ID is only valid within the context of the response it is in.\n","type":"string"},"name":{"description":"Human readable name of the owner of the transport service.","type":"string"},"website":{"description":"Link to the agency's website.","allOf":[{"$ref":"#/components/schemas/Uri"}]}},"required":["id","name"]},"Avoid":{"type":"object","properties":{"features":{"description":"A comma-separated list of features that routes should avoid.\n\n* `seasonalClosure`\n* `tollRoad`: This option avoids roads that have an applicable toll.\n* `controlledAccessHighway`\n* `ferry`\n* `carShuttleTrain`\n* `tunnel`\n* `dirtRoad`\n* `difficultTurns`: **Deprecated** (see Notes for details). This option avoids difficult turns, sharp turns and U-turns on multi-digitized roads, intersections and stopover-type waypoints. It is only supported for the `truck` transport mode.\n* `uTurns`: This option avoids U-turns on multi-digitized roads, intersections, stopover-type waypoints. U-turns on mini roundabouts (roundabouts with a small turn radius, which are difficult for long vehicles to navigate) are avoided when `transportMode = truck`. This option is not supported for pedestrian, bicycle and scooter transport modes.\n\n**Notes**\n- It may not always be possible to find a route which avoids the requested feature. A route may not be returned, or one may be returned with a critical notice.\n- Using `avoid[features]=tollRoad` does not optimize the route to reduce the overall toll costs.\n- Using `avoid[features]=tollRoad` is not recommended for large vehicles, e.g., trucks or buses. Even if a route is suggested, it may use smaller roads, where driving such vehicles is not convenient or safe.\n- `avoid[features]=difficultTurns` is currently deprecated and will be ignored in the future. Using `avoid[features]=difficultTurns` together with `avoid[features]=controlledAccessHighway` or `avoid[features]=tollRoads` is not recommended, as it may lead to routes which could include difficult turns.\n","type":"string"},"areas":{"$ref":"#/components/schemas/Areas"},"segments":{"description":"A comma separated list of segment identifiers that routes should avoid going through.\n\nEach entry has the following structure:\n`{segmentId}(#{direction})?`\n\nThe individual parts are:\n* segmentId: The identifier of the referenced topology segment inside the catalog, example: `here:cm:segment:207551710`\n* direction (optional): Either '*' for bidirectional (default), '+' for positive direction, or '-' for negative direction\n\nExample of a parameter value excluding two segments:\n`here:cm:segment:207551710#+,here:cm:segment:76771992#*`\n\n**Note**: Maximum number of penalized segments in one request should not be greater than 1000.\n \"Penalized segments\" refers to segments that either have a restriction on maximum baseSpeed with `maxSpeedOnSegment`\n or avoided with `avoid[segments]`\n","type":"string"},"zoneCategories":{"description":"Specifies a list of categories of zones which routes should 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 should not be taken into account for evaluation of zone categories to avoid.\n\nSupported zone categories:\n * `vignette`\n * `congestionPricing`\n * `environmental`\n\n**Note**: Zones that don't apply to the current vehicle aren't avoided.\nTime-dependent zones are avoided only during the validity period.\n\nExample of zone categories avoidance:\n`avoid[zoneCategories]=environmental,vignette`\n\nExample of zone categories avoidance with exceptions:\n`avoid[zoneCategories]=environmental,vignette;exceptZoneIds=here:cm:envzone:3`\n","type":"string"},"zoneIdentifiers":{"description":"A comma separated list containing identifiers of zones that routes should avoid going through.\n\n**Note**: Zones specified by id in this manner are avoided even if their conditions don't apply to the current vehicle.\nTime-dependent zones are avoided by id even outside of the validity period.\n\nExample of an identifier referencing an environmental zone:\n`here:cm:envzone:2`\n","type":"string"},"truckRoadTypes":{"description":"A comma-separated list of truck road type identifiers to be avoided.\n\nA truck road type is an identifier associated with roads that have additional regulations applied by local administration for traversal by heavy vehicles like trucks.\nFor example, the BK Bearing Class regulations in Sweden, and ET categories in Mexico.\nIdentifiers for supported truck road types are specified in HERE Map Content\n[TruckRoadType](https://docs.here.com/map-content/docs/truckroadtypeattribute).\n\nExample: `avoid[truckRoadTypes]=BK1,BK2,BK3,BK4`\n","type":"string","example":"BK1,BK2,BK3,BK4"},"tollTransponders":{"description":"Specifies that routes should avoid roads where the specified toll transponders are the only payment method.\n\nThe value of the parameter is a comma-separated list of transponder systems that the user has. Alternatively,\nthe user can also specify `all` as a list element to state they have all required transponders along any potential route.\n\n**Note**: Currently, the only valid value is `all`.\nExample: `avoid[tollTransponders]=all`\n","type":"string"}}},"BaseAction":{"type":"object","description":"An action to be performed between sections or during a section.","properties":{"action":{"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","type":"string"},"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":{"description":"Description of the action (e.g. Turn left onto Minna St.).","type":"string"}},"required":["action","duration"]},"BaseSummary":{"type":"object","description":"Total value of key attributes for a route section.","properties":{"duration":{"$ref":"#/components/schemas/Duration"},"length":{"$ref":"#/components/schemas/Distance"},"baseDuration":{"description":"Duration of this span (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"}]}},"required":["duration","length"]},"ChargingConnectorAttributes":{"type":"object","description":"Details of the connector that is suggested to be used in the section's `postAction` for charging.","properties":{"power":{"description":"Power supplied by the suggested connector in kW.","type":"number"},"current":{"description":"Current of the suggested connector in Amperes.","type":"number"},"voltage":{"description":"Voltage of the suggested connector in Volts.","type":"number"},"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"}]}},"required":["power","supplyType","connectorType"]},"CorridorArea":{"type":"object","description":"A polyline with a specified radius in meters that defines an area.","required":["type","polyline","radius"],"properties":{"type":{"type":"string","example":"corridor"},"polyline":{"type":"array","description":"List of coordinates defining polyline.","items":{"$ref":"#/components/schemas/Coordinate"},"minItems":2,"maxItems":100},"radius":{"type":"integer","description":"The width in meters of the corridor determines the outline of the polygon.","minimum":1,"maximum":1000}}},"DynamicSpeedInfo":{"type":"object","description":"Describes dynamic speed information, such as traffic speed, estimated speed without traffic, and turn time.\n","properties":{"trafficSpeed":{"description":"Estimated speed (in meters per second) of a vehicle on the road-segment, taking into account traffic-related constraints.\n**Note:** Will be the same as `baseSpeed` if `traffic[mode]=disabled` is specified.\n","allOf":[{"$ref":"#/components/schemas/Speed"}]},"baseSpeed":{"description":"Estimated speed (in meters per second) without considering any traffic-related constraints.","allOf":[{"$ref":"#/components/schemas/Speed"}]},"turnTime":{"description":"Estimate of the time (in seconds) it takes to turn from this span into the next. It takes into account both traffic conditions and the specific transport-mode.\n","allOf":[{"$ref":"#/components/schemas/Duration"}]}},"required":["trafficSpeed","baseSpeed","turnTime"]},"EVPhysicalModel":{"description":"Specifies parameters required for calculation of energy consumption for electric vehicles using physical model.","type":"object","properties":{"auxiliaryPowerCurve":{"description":"Function curve specifying power consumed by the vehicle's auxiliary systems as a function of time.\nUse this instead of the single-valued `auxiliaryPowerConsumption` or `auxiliaryConsumption` when auxiliary consumption is not constant.\nEmpirical model uses `auxiliaryConsumption` parameter, while physical model has `auxiliaryPowerConsumption` parameter.\nOnly one of these three different parameters can be set.\n\nWhen using this with the empirical model, please note unit difference with `auxiliaryConsumption`.\n\nThe format of the string is a pipe separated list of number pairs, as follows:\n\n```\n,|,|...|,\n```\n\nwhere time values are strictly increasing non-negative integer values in seconds, representing elapsed driving time since the start of the route, and power values are strictly decreasing non-negative floating point values in watts.\nThe function is piecewise constant, e.g., for any elapsed time in the range `[TIME_0, TIME_1]` the value of the function is `POWER_0`.\nFor time greater than `TIME_N`, the value of the function is `POWER_N`. TIME_0 must be explicitly set to zero.\nThe time in the last pair, `TIME_N`, can be at most 1800 (30 minutes).\n\nAuxiliary consumption applies during stops, including charging stops.\nAt charging stops, power used for charging is reduced by the amount used for auxiliary consumption.\n\nThe list can have a maximum of six `TIME`,`POWER` pairs.\n\n**Note**: When using this feature `departureTime` cannot be set to `any`.\n\n**Note:** This is a **beta** release of this feature and may contain bugs or exhibit unexpected behaviour. Related APIs are subject to change without a deprecation process.\n","type":"string"},"driveEfficiency":{"description":"The proportion of the energy drawn from the battery that is used to move the vehicle. (This is to factor in energy losses through heat in the motors, for example.)\n**Note:** This attribute is required when using the physical model `consumptionModel=physical` for EV consumption.\n","type":"number","minimum":0.1,"maximum":1},"recuperationEfficiency":{"description":"The proportion of the energy gained when braking or going downhill that can be recuperated and restored as battery charge.\n**Note:** This attribute is required when using the physical model `consumptionModel=physical` for EV consumption.\n","type":"number","minimum":0,"maximum":1},"auxiliaryPowerConsumption":{"description":"Power (in W) consumed by the vehicle's auxiliary systems (for example, air conditioning, lights).\n\nAuxiliary power consumption applies during stops, including charging stops.\nAt charging stops, power used for charging is reduced by the amount used for auxiliary consumption.\n","type":"number","minimum":0},"airDensity":{"description":"The density of air (in kg/m³) used for calculating aerodynamic drag.\n","type":"number","minimum":0.5,"maximum":2,"default":1.225},"initialCharge":{"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","type":"number","minimum":0,"maximum":1000},"maxCharge":{"description":"Total capacity of the vehicle's battery (in kWh).\n","type":"number","minimum":0,"maximum":1200},"chargingCurve":{"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,,,,...,,\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\nMaximum value of rate must not be greater than 2000 kW. The values of charge in the curve are only validated up to the value of `maxChargeAfterChargingStation` since values outside this range are not used.\nMinimum value of rate must not be less than 7kW. The values of charge in the curve are only validated up to the value of `maxChargeAfterChargingStation` since values outside this range are not used.\n\nThe algorithm calculates a route as the best possible combination of driving and charging\nparts and uses the charging curve to evaluate the most efficent range of\ncharging. For example, if the rate of charging is high at lower levels of battery, but slows down significantly after charging a little, stopping\noften and charging less, but quicker, at each station might be better for the overall route.\nBecause batteries lose charging speed with use, providing a charging curve for the\nexact battery would give more accurate charging time estimate than providing a\ngeneric curve for all batteries of one type.\n","type":"string","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"},"maxChargingVoltage":{"description":"Maximum charging voltage supported by the vehicle's battery (in Volt).\n","type":"number","minimum":0,"maximum":2000},"maxChargingCurrent":{"description":"Maximum charging current supported by the vehicle's battery (in Ampere).\n","type":"number","minimum":0,"maximum":2000},"maxChargeAfterChargingStation":{"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\nThe algorithm calculates a route as the best possible combination of driving and charging\nparts so charging at a charging station does not happen strictly to the value of\nthis parameter. Instead, the algorithm attempts to leave every station with\ndifferent charge levels, and only the best possible combination of charging stations\nand target charge will form the final route.\n\nFor example, if there is a fast but not reachable charging station on the route,\nthe algorithm prefers first to charge at a slower station, but only to a level that enables it\nto reach the fast station. This way it calculates the best possible combination of driving\nand charging parts.\n","type":"number","minimum":0},"minChargeAtChargingStation":{"description":"Minimum charge when arriving at a charging station (in kWh).\nValue must be less than the value of `maxChargeAfterChargingStation`.\n\nThe algorithm calculates a route as the best possible combination of driving and charging\nparts so visiting a charging station is planned not when the remaining charge is close\nto the value of this parameter but when it is part of the best possible charging\nplan for the given route.\n\nFor example, it might prefer charging a still half-full battery at the fast charging station because\nthere are only slower stations later on the route and the remaining charge is not\nenough to reach the destination without charging at all.\n","type":"number","minimum":0},"minChargeAtFirstChargingStation":{"description":"Minimum charge when arriving at first charging station (in kWh).\nValue must be less than the value of `maxChargeAfterChargingStation`.\n\nThis overrides `minChargeAtChargingStation` for the first charging station. If not specified, `minChargeAtChargingStation`\nwill be used for all charging stations, including the first one.\n\nThis is usually used when the current charge is too low to reach a charging station within `minChargeAtChargingStation` limits.\n","type":"number","minimum":0},"minChargeAtDestination":{"description":"Minimum charge at the final route destination (in kWh).\nValue must be less than the value of `maxChargeAfterChargingStation`.\n\nThe algorithm calculates a route as the best possible combination of driving and charging\nparts while making sure that the actual value of the charge at the destination would be close to the\nvalue of this parameter. I.e., the resulting value is expected to be bigger\nthan this parameter's value by no more than 10% of the battery capacity.\n","type":"number","minimum":0},"chargingSetupDuration":{"description":"Time spent (in seconds) after arriving at a charging station but before actually charging\n(for example, time spent for payment processing).\n","type":"integer","format":"int32","minimum":0,"maximum":1800},"maxChargingDuration":{"description":"Maximum time spent (in seconds) at a charging station unless otherwise specified in a user-introduced charging waypoint. Charging waypoint may\nspecify max or min duration, both of which can be higher. (see documentation for the `via` parameter)\n","type":"integer","format":"int32","minimum":1800},"connectorTypes":{"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 \"CCS1\"\n * `iec62196Type2Combo`: Type 2 Combo connector, commonly called \"CCS2\"\n * `chademo`: CHAdeMO connector\n * `tesla`: Deprecated alias for `saeJ3400`. Use `saeJ3400` instead. Cannot be used in combination with `saeJ3400`\n * `saeJ3400`: North American Charging Standard (NACS) connector.\n * `gbtDc`: Guobiao GB/T 20234.3 DC connector\n","type":"string","example":"iec62196Type1Combo,chademo"},"maxPowerAtLowVoltage":{"description":"The maximum power (in kW) at which a vehicle can charge given these conditions:\n* The charging station connector's maximum supply voltage < 800 V.\n* The vehicle's `maxChargingVoltage` >= 800 V.\n\nThe `consumablePower` at a station is then taken to be the lower of `maxPowerAtLowVoltage` and the charging station's available power.\n","type":"number","minimum":0,"default":45},"maxDrivingTimeBeforeCharge":{"description":"The maximum driving time before the first charging stop. This attribute can be used in conjunction with `minTimeAtFirstChargingStation`\nto delay the charging stop and extend it, if required, up to the mandated rest period for the drivers. When this attribute is provided, `minTimeAtFirstChargingStation`\nis also required.\n","type":"number","maximum":18000},"minTimeAtFirstChargingStation":{"description":"The minimum duration at the first charging stop, including the charging time and subsequent waiting time.\nThis attribute can be used as standalone or in conjunction with `maxDrivingTimeBeforeCharge`.\n","type":"number","minimum":1,"maximum":1800}},"required":["driveEfficiency","recuperationEfficiency"]},"Exclude":{"type":"object","description":"Options to exclude strictly during the route calculation.","properties":{"countries":{"description":"A comma separated list of three-letter country codes (ISO-3166-1 alpha-3 code) that\nroutes will exclude.\n- Format: `{country1}[,country2][,country...]`\n + `{country}` - Country code according to (ISO-3166-1 alpha-3)\n- Example: `CZE,SVK` - exclude Czechia and Slovakia from routing.\n\nNote - Exclude countries guarantees exclusion, but doesn't guarantee finding a route.\n","type":"string"},"states":{"description":"A pipe separated list of country-aggregated state codes.\n\n- Format: `{country1}:{state1.1}[,state1.2][,state1.3]...[|{country2}:{state2.1}[,state2.2]]...`\n + `{country}` - Country code according to (ISO-3166-1 alpha-3)\n + `{state}` - State code part according to (ISO 3166-2)\n- Examples:\n + `USA:NY,PA` - exclude USA's New York and Pennsylvania states\n + `USA:NY,PA|CAN:QC`- exclude USA's New York, Pennsylvania states and Canada's Quebec province\n- Notes:\n + Exclude states guarantees exclusion, but doesn't guarantee finding a route.\n + Some countries don't have the state code data available for them, so the states in those countries won't be excluded.\n","type":"string"},"areas":{"$ref":"#/components/schemas/Areas"}}},"ExitInfo":{"type":"object","description":"Exit information attached to an offset action","properties":{"number":{"description":"Number of the exit (e.g. '18')","type":"array","items":{"$ref":"#/components/schemas/LocalizedString"}}},"example":{"exit":{"number":[{"value":"15","language":"de"}]}}},"FarePass":{"type":"object","description":"Specifies whether this `Fare` is a multi-travel pass, and its characteristics","properties":{"returnJourney":{"description":"This pass includes the fare for the return journey.","type":"boolean"},"validityPeriod":{"$ref":"#/components/schemas/FarePassValidityPeriod"},"travels":{"description":"This pass allows for the specified number of travels.","type":"integer"},"transfers":{"description":"Indicates if transfers are permitted with this pass, and if so, how many.","type":"integer"},"seniorPass":{"description":"This pass is valid only if presented by a senior person.","type":"boolean"}}},"HazardousGoodsRestrictionArray":{"description":"Provides a list of all hazardous goods that are restricted during the trip.","type":"array","items":{"$ref":"#/components/schemas/HazardousGoodsRestriction"},"example":["gas","flammable"]},"HealthResponseFailSchema":{"type":"object","description":"Returns the health of the service","properties":{"status":{"description":"Health status of the service:\n\n* `ok` - the service is operating normally\n* `fail` - the service is currently encountering a failure\n","type":"string","enum":["fail"]}}},"HealthResponseOKSchema":{"type":"object","description":"Returns the health of the service","properties":{"status":{"description":"Health status of the service:\n\n* `ok` - the service is operating normally\n* `fail` - the service is currently encountering a failure\n","type":"string","enum":["ok"]}}},"LicensePlateRestriction":{"description":"Contains details of the violated license plate restriction.","type":"object","properties":{"type":{"$ref":"#/components/schemas/LicensePlateRestrictionType"},"forbiddenCharacters":{"description":"A list of restricted characters in the vehicle license plate.\n\nThe `type` property indicates which character of the vehicle license plate is considered for matching.\nThe condition is met if that character matches any of the characters in the `forbiddenCharacters` array.\n\nFor example, if `type` is set to `lastCharacter` and `forbiddenCharacters` is set to `[\"7\", \"8\"]` then the condition is met if the last character\nof the vehicle license plate is either 7 or 8.\n","type":"array","items":{"type":"string","minLength":1,"maxLength":1},"example":["1","3","5","7","9"]}}},"LocalizedRouteNumber":{"description":"Represents a route number in specific language with optional cardinal direction and route level.","example":{"value":"US-101","language":"en","direction":"south","routeType":1},"type":"object","properties":{"value":{"description":"String written in the language specified in the language property.","type":"string"},"language":{"description":"Language in BCP47 format","type":"string"},"direction":{"description":"This property indicates the official directional identifier assigned to highways. Use direction on sign in conjunction with official name or route number.\nFor example, for route guidance, use \"US-101 S\" and not just \"US-101\" when appropriate.\n\nNote that the official direction is not necessarily the travel direction. For example, US-101 through the city of Sunnyvale is physically located East to West.\nHowever, the official direction on sign is North/South.\n","type":"string","enum":["north","south","east","west"]},"routeType":{"description":"Specifies route type for different route element. These values must be used in conjunction with a separate HERE data product: Country Profile Road Signs.\nOne of the usage example for this property is it affects how the road shield will be rendered, i.e.\nthis route type might change the shape, color and the font of the road shield.\nRelated examples for different countries can be found [here](https://en.wikipedia.org/wiki/Highway_shield).\nPossible values are from 1 to 6. But if some countries add extra route type in the future, this range could change as well.\n","type":"integer","minimum":1,"maximum":6}},"required":["value"]},"MatchTraceVia":{"type":"object","description":"Via waypoint in the middle of route","properties":{"index":{"description":"Index of the corresponding trace point","type":"integer","minimum":1},"stopDuration":{"description":"Desired duration for the stop, in seconds","allOf":[{"$ref":"#/components/schemas/Duration"}]}},"required":["index"]},"Notice":{"type":"object","description":"A notice contains important notifications.","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"}}},"required":["code"]},"PedestrianMode":{"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","type":"string","x-extensible-enum":["pedestrian"],"default":"pedestrian"},"PermittedNetworksPost":{"description":"**Disclaimer: This parameter is currently in beta release, and is therefore subject to breaking changes.**\n\nA list of road networks permitted to be used. These road networks are considered mandatory and will be used as much as possible, even at the expense of shorter routes.\n\nFor the general description of the functionality please refer to the `permittedNetworks` parameter of the\nquery string.\n\nThe list is provided as an array of objects, where each object contains the country code and list of road network codes for that country.\n\nNote: This parameter is required for transport mode `networkRestrictedTruck` and is not supported for other transport modes.\n","type":"array","uniqueItems":true,"maxItems":100,"items":{"type":"object","properties":{"country":{"$ref":"#/components/schemas/CountryCode"},"states":{"type":"array","uniqueItems":true,"maxItems":8,"items":{"$ref":"#/components/schemas/StateCode"}},"networks":{"type":"array","uniqueItems":true,"maxItems":15,"items":{"type":"string","enum":["fiftyMax","hpmv","bDouble19","bDouble23Gml","bDouble23Hml","bDouble26Gml","bDouble26Hml","bDouble27Dot5","bTripleGml","bTripleHml","pbs2A","pbs2B","pbs3A","pbs3B","pbs4A"]},"description":"List of network codes according to the description of the `permittedNetworks` query parameter"}},"required":["country","networks"]}},"PolygonArea":{"type":"object","description":"A polygon defined as a list of coordinates.\n\nThe polygon is automatically closed, so repeating the first vertex is not required. Self-intersecting polygons are not supported.\n","required":["type","outer"],"properties":{"type":{"type":"string","example":"polygon"},"outer":{"type":"array","description":"List of coordinates defining the outline of the polygon.","items":{"$ref":"#/components/schemas/Coordinate"},"minItems":3,"maxItems":100}}},"Rerouting":{"description":"Rerouting parameters allow to request a new route calculation based on the route handle.\n\nAll attributes are optional.\n","type":"object","properties":{"mode":{"$ref":"#/components/schemas/ReroutingMode"},"lastTraveledSectionIndex":{"description":"Can be used to indicate the index of the last traveled route section on multi-section\nroutes. The traveled part of the route won't be reused.\n\nIf the last traveled section is specified and the current position, i.e., the new\n`origin`, is provided, it is expected to be on the last traveled section. If it is\nnot on the last traveled section, it is treated as not on the route, triggering\nreturn to route, if enabled, to the waypoint at the end of the last traveled section.\n\nIf the last traveled section index is not specified, the current position can be\nmatched to any section of the route. In this case the route will continue to the\nnext waypoint after the current position, i.e., the new `origin`. If the current\nposition is not on the route, return to route, if enabled, will by default return\nto the waypoint at the end of the first section.\n","type":"integer"},"traveledDistanceOnLastSection":{"description":"Offset in meter to the last visited position on the route section defined by the `lastTraveledSectionIndex`.\n","type":"integer","default":0}},"example":{"$ref":"#/components/examples/ReroutingExample"}},"RouteLabel":{"type":"object","description":"Road name or route number distinguishing a route from other alternatives.\n","properties":{"label_type":{"type":"string","enum":["Name","RouteNumber"]},"name":{"$ref":"#/components/schemas/LocalizedString"}}},"RoutingErrorResponse":{"description":"Response in case of error","type":"object","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 vehicle options and transport mode. |\n| `E605011` | Invalid combination of avoid parameter 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 country code. Check `countries` under `Exclude`. |\n| `E605017` | `spans` contains a value whose dependency has not been requested |\n| `E605018` | Invalid combination of departure and arrival time |\n| `E605019` | `truck[weightPerAxle]` and `truck[weightPerAxleGroup]` are incompatible |\n| `E605020` | Invalid combination of `radius` and `snapRadius` |\n| `E605021` | Invalid Combination of `vehicle[occupancy]`/`allow[hot]`/`allow[hov]` and `vehicle[hovOccupancy]` |\n| `E605022` | `radius` * `radiusPenalty` / 100 must not exceed 7200 |\n| `E605023` | Invalid combination of `radiusPenalty` and `snapRadius` |\n| `E605024` | `vehicle[currentWeight]` or `vehicle[grossWeight]` exceeds limit for given `transportMode`. |\n| `E605025` | Invalid state code. Check `states` under `Exclude` |\n| `E605026` | Invalid country code. Check `states` under `Exclude` |\n| `E605027` | Ev parameters cannot be used with the specified transportMode. |\n| `E605028` | Fuel parameters cannot be used with the specified transportMode. |\n| `E605029` | State code not available in map data. Check `states` under `Exclude` |\n| `E605030` | Invalid EV options. Check `ev` for details. |\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]` or `vehicle[speedCapPerFc]` for details. |\n| `E605036` | Consumption parameters are not supported for combination of EV and Fuel-based vehicle. Check `ev` or `fuel` for details. |\n| `E605037` | Invalid Fuel options. Check `fuel` for details. |\n| `E605039` | Invalid combination of driver schedule and transport mode. |\n| `E605040` | Invalid combination of `ev[makeReachable]` and `transportMode`. Check `ev` for details. |\n| `E605041` | Invalid combination of `ev[makeReachable]` and `routingMode`. Check `ev` for details. |\n| `E605043` | Invalid combination of `ev[makeReachable]` and `avoid` options. Check `ev` for details. |\n| `E605047` | Invalid combination of `ev[makeReachable]` and `arrivalTime`. Check `ev` for details. |\n| `E605048` | Invalid combination of avoid feature `difficultTurns` and truck category `lightTruck`. |\n| `E605052` | Invalid number of trace points. Check `MatchTrace` for the minimum and maximum number of trace points allowed. |\n| `E605053` | Invalid Match trace via. Check `via` in `MatchTrace` for valid indexes. |\n| `E605054` | Too many avoid areas. Check `areas` for the maximum number of avoid areas allowed. |\n| `E605055` | Invalid trailer axle count. |\n| `E605056` | Too many avoid polygons. Check `areas[polygon]` for the maximum number of polygons allowed. |\n| `E605057` | Too many vertices in the polygon. Check `areas[polygon]` for the maximum number of vertices allowed. |\n| `E605058` | Not enough vertices in the polygon. Check `areas[polygon]` for the minimum number of vertices allowed. |\n| `E605059` | Polygon is self-intersecting. Check `areas[polygon]`. |\n| `E605060` | Invalid trace point. Check `lat` value must be between -90 and 90 and `lng` value must be between -180 and 180. |\n| `E605064` | Invalid transport mode for speed cap per Functional Class, check `vehicle[speedCapPerFc]` for details. |\n| `E605076` | Too many charging stations to exclude. Check `ev[excludeChargingStations]` for maximum number of charging stations allowed. |\n| `E605077` | `rerouting[lastTraveledSectionIndex]` is out of range. |\n| `E605101` | Credentials not allowed for calculating routes in Japan. |\n| `E605201` | RouteHandle not valid (anymore). (Re-)calculate route to retrieve new handle. |\n| `E605204` | Invalid combination of EV and driver schedule. |\n| `E605301` | Pedestrian options are only supported for transport mode `pedestrian`. |\n| `E605302` | Routing zones is not supported for transport mode `pedestrian`. |\n| `E605303` | Avoiding routing zones is not supported for transport mode `pedestrian`. |\n| `E605304` | Avoiding truck road types is not supported for transport mode `pedestrian`. |\n| `E605400` | Customization not supported. |\n| `E605501` | Too many requests. |\n| `E605502` | Too complex request. |\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"}},"required":["title","status","code","cause","action","correlationId"]},"RoutingZone":{"type":"object","description":"Information about a routing zone.","properties":{"ref":{"$ref":"#/components/schemas/RoutingZoneReference"},"type":{"description":"Extensible enum: `environmental` `vignette` `...` \nThe type of the routing zone. A routing zone is defined based on an underlying feature/resource.\nThe standard representation of a routing zone reference is `{catalogHrn}:{catalogVersion}:({layerId})?:{tileId}:{zoneId}` (refer to `RoutingZoneReference` description in this document for details).\n`{zoneId}` represents the identifier of the underlying feature/resource within the catalog, in the `\"domain:system:type:id\"` format.\nThis attribute corresponds to the `\"domain:system:type\"` portion of the identifier.\nE.g. `type=environmental` corresponds to the `\"here:cm:envzone\"` portion of the identifiers of all environmental zones within a catalog.\n\nTo further distinguish between the sub-categories of the `type` (if applicable) use the `category` attribute.\n\nNOTE: To maintain legacy support `type=vignette` is not renamed but corresponds to the `\"here:cm:tollsystem\"` portion of the identifier for all toll cost features.\n","type":"string","x-extensible-enum":["environmental","vignette"]},"name":{"description":"The routing zone's name.","type":"string"},"category":{"description":"Extensible enum: `environmental` `vignette` `congestionPricing` `...` \nThe category of the routing zone. Corresponds to the sub-category (if applicable) of the feature/resource defining a routing zone, e.g. `vignette` and `congestionPricing` sub-categories of the toll cost features.\n","type":"string","x-extensible-enum":["environmental","vignette","congestionPricing"]}}},"SignpostLabelText":{"type":"object","description":"Text on a signpost label.","properties":{"name":{"$ref":"#/components/schemas/LocalizedString"}}},"TollCollectionLocation":{"type":"object","description":"Refers to the physical location where the toll is collected. This can include various structures such as toll booths, transponder readers, or number-plate cameras.\nIt's important to note that certain toll collection methods, such as vignettes, do not have specific toll collection locations associated with them, and therefore this element\nwill not be present at all.\n\nThe value of this property is a `Location` that specifies the coordinates of the payment location.\n","properties":{"name":{"description":"A descriptive name of the location.\n","type":"string"},"location":{"$ref":"#/components/schemas/Location"}},"required":["location"]},"TrafficIncident":{"type":"object","description":"An incident describes a temporary event on the road network.\nIt typically refers to a real world incident (accident, road construction, weather condition, etc.)\non a street or street segment\n","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"},"id":{"description":"Traffic Incident unique identifier,\n\nExample of an incident identifier in standard representation:\nhere:traffic:incident:1000155780078589348\n\nId usage:\nIncident details can be queried from the traffic service. See\n[this tutorial](https://docs.here.com/traffic-api/docs/incidents-by-id-incidents-1).\n\n**Notice**:\nIn most cases, the ID comes from a third party incident supplier.\nThis means that once an incident has expired, the ID might be reused\n","type":"string"}}},"TransitIncident":{"type":"object","description":"An incident describes disruptions on the transit network.\nDisruptions scale from delays to service cancellations.\n","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"}]}},"required":["type","effect"],"example":{"summary":"The subway is closed each night between 1 AM and 5 AM.","description":"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":"maintenance","effect":"modifiedService"}},"TransitMode":{"title":"Modes","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","type":"string","x-extensible-enum":["highSpeedTrain","intercityTrain","interRegionalTrain","regionalTrain","cityTrain","bus","ferry","subway","lightRail","privateBus","inclined","aerial","busRapid","monorail","carShuttleTrain","flight","spaceship"]},"TruckTypeWithDefault":{"description":"Specifies the type of the 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 (also known as a semi-truck).\n","deprecated":true,"type":"string","enum":["Straight","Tractor"],"default":"Straight"},"VehicleMode":{"description":"Extensible enum: `car` `truck` `bicycle` `scooter` `taxi` `bus` `privateBus` `networkRestrictedTruck` `...` \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","type":"string","x-extensible-enum":["car","truck","bicycle","scooter","taxi","bus","privateBus","networkRestrictedTruck"],"default":"car"},"VersionResponse":{"type":"object","description":"Returns the versions of the service components.","properties":{"apiVersion":{"type":"string","description":"The current version of the API.","example":"8.18.0"},"serviceVersion":{"type":"string","description":"The current version of the service.","example":"2022-12-15-b706cc8c-9057409"},"dataVersions":{"type":"array","items":{"$ref":"#/components/schemas/DataVersion"},"description":"Returns the versions of data sets used by the service."}},"required":["apiVersion"]},"ViaNoticeDetail":{"description":"Details about via waypoint.","type":"object","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","enum":["via"]},"index":{"description":"Index of the via waypoint not matched. When the destination waypoint was not matched, no `via` detail is returned.","type":"integer","minimum":0}},"required":["type"]},"ViolatedChargingStationOpeningHours":{"description":"A charging stop was planned at the destination of this section, but the `postActions` would not be completed within the opening hours.\n","type":"object","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","enum":["violatedOpeningHours"]},"opening_hours":{"description":"Information about the opening time intervals of the selected charging station.\n","allOf":[{"$ref":"#/components/schemas/TimeDomain"}]}},"required":["type"]},"ViolatedTransportMode":{"description":"Contains details about the violated transport mode on this road, such as trucks being generally forbidden.\n","type":"object","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","enum":["violatedTransportMode"]}},"required":["type"]},"ViolatedTruckRoadType":{"description":"Contains details about the violated truck road type on this road.\n","type":"object","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","enum":["truckRoadType"]},"truckRoadType":{"description":"The truck road type causing this violation.","type":"string"}},"required":["type"]},"WebLink":{"type":"object","description":"The URL address to an external resource.","properties":{"id":{"description":"Unique identifier for the web link. It is used to deduplicate links defined in multiple sections.","type":"string"},"href":{"$ref":"#/components/schemas/Uri"},"text":{"description":"Text describing the url address (e.g. The example website).","type":"string"},"hrefText":{"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":"string"}},"required":["id","text"],"example":{"id":"88-7568-21.07.2023","text":"Information for public transit provided by ThePublicTransit GmbH"}},"AccessPointPlace":{"type":"object","description":"Access point to a venue/station","properties":{"name":{"description":"Location name","type":"string"},"waypoint":{"description":"If present, this place corresponds to the `via` in the request with the same index.\n\nExample:\n\nIf the request contains `via=&via=`\n* the place corresponding to `` in the response will have `waypoint: 0`\n* the place corresponding to `` in the response will have `waypoint: 1`.\n\nNotes:\n* `waypoint` is not present for `origin` and `destination` places. `origin` and `destination` waypoints can be trivially identified in the response as the `departure` of the first section and the `arrival` of the final section, respectively.\n* `waypoint` is not present for any stops that are added automatically by the router.\n","type":"integer","minimum":0},"type":{"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","type":"string","enum":["accessPoint"]},"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"}]},"displayLocation":{"description":"If present, the display position of this location provided in the request or that of the auto-added waypoint. This is different from the originalLocation and location which are generally expected to be on the navigable road network, i.e., on segments. This coordinate, for example, is the location of the POI as shown by the pin on a map.","allOf":[{"$ref":"#/components/schemas/Location"}]},"sideOfStreet":{"description":"Location of the waypoint or destination, relative to the driving direction on the street/road.\n\n**NOTE:** Based on the original waypoint position and `sideOfStreetHint` waypoint property.\n - If `sideOfStreetHint` property is specified, it takes priority in determining the side of street in the response.\n - Nothing is returned in the response in case the side of street is ambiguous (too close to the street),\n or if the position is too far from the street.\n\n* 'left`: The left side of the street in relation to the driving direction of the route.\n* `right`: The right side of the street in relation to the driving direction of the route.\n","type":"string","enum":["left","right"]},"wheelchairAccessible":{"description":"Information about accessibility for people with a disability and who use a wheelchair.\n\n* `unknown` - Accessibility information is not available.\n* `yes` - Access point is wheelchair accessible.\n* `limited` - Accessibility is limited or assistance is required.\n* `no` - No accessible path from the access point to platforms.\n","allOf":[{"$ref":"#/components/schemas/WheelchairAccessibility"}]}},"required":["type","location"],"example":{"type":"place","location":{"lat":50.339167,"lng":18.93}}},"Area":{"oneOf":[{"$ref":"#/components/schemas/BoundingBoxArea"},{"$ref":"#/components/schemas/PolygonArea"},{"$ref":"#/components/schemas/EncodedPolygonArea"},{"$ref":"#/components/schemas/CorridorArea"},{"$ref":"#/components/schemas/EncodedCorridorArea"}],"discriminator":{"propertyName":"type","mapping":{"boundingBox":"#/components/schemas/BoundingBoxArea","polygon":"#/components/schemas/PolygonArea","encodedPolygon":"#/components/schemas/EncodedPolygonArea","corridor":"#/components/schemas/CorridorArea","encodedCorridor":"#/components/schemas/EncodedCorridorArea"}},"description":"Area specified by boundingBoxes or polygons (as encoded polyline or as list of geopts ) or corridor area.\n\nNotes:\n* Maximum count of avoided and excluded polygons and corridors is 20.\n* Maximum total count of avoided and excluded bounding boxes, polygons, corridors, including exceptions, is 250.\n"},"Attribution":{"type":"object","description":"The URL address to an external resource.","properties":{"id":{"description":"Unique identifier for the web link. It is used to deduplicate links defined in multiple sections.","type":"string"},"href":{"$ref":"#/components/schemas/Uri"},"text":{"description":"Text describing the url address (e.g. The example website).","type":"string"},"hrefText":{"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":"string"},"type":{"$ref":"#/components/schemas/AttributionLinkType"}},"required":["id","text"],"example":{"id":"88-7568-21.07.2023","text":"Information for public transit provided by ThePublicTransit GmbH"}},"BoardAction":{"description":"An action to board a ferry.","type":"object","properties":{"action":{"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","type":"string","enum":["board"]},"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":{"description":"Description of the action (e.g. Turn left onto Minna St.).","type":"string"}},"required":["action","duration"]},"ChargingAction":{"description":"An action to charge the vehicle.\n","type":"object","properties":{"action":{"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","type":"string","enum":["charging"]},"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":{"description":"Description of the action (e.g. Turn left onto Minna St.).","type":"string"},"consumablePower":{"description":"Maximum charging power (in kW) available to the vehicle, based on the properties of the charging\nstation and the vehicle.\n","type":"number"},"arrivalCharge":{"description":"Estimated vehicle battery charge before this action (in kWh).\n","type":"number"},"targetCharge":{"description":"Level to which vehicle battery should be charged by this action (in kWh).\n","type":"number"}},"required":["action","duration"]},"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","type":"object","properties":{"action":{"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","type":"string","enum":["chargingSetup"]},"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":{"description":"Description of the action (e.g. Turn left onto Minna St.).","type":"string"}},"required":["action","duration"]},"ChargingStationPlace":{"type":"object","description":"A charging station","properties":{"name":{"description":"Human readable name of this charging station","type":"string"},"waypoint":{"description":"If present, this place corresponds to the `via` in the request with the same index.\n\nExample:\n\nIf the request contains `via=&via=`\n* the place corresponding to `` in the response will have `waypoint: 0`\n* the place corresponding to `` in the response will have `waypoint: 1`.\n\nNotes:\n* `waypoint` is not present for `origin` and `destination` places. `origin` and `destination` waypoints can be trivially identified in the response as the `departure` of the first section and the `arrival` of the final section, respectively.\n* `waypoint` is not present for any stops that are added automatically by the router.\n","type":"integer","minimum":0},"type":{"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","type":"string","enum":["chargingStation"]},"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"}]},"displayLocation":{"description":"If present, the display position of this location provided in the request or that of the auto-added waypoint. This is different from the originalLocation and location which are generally expected to be on the navigable road network, i.e., on segments. This coordinate, for example, is the location of the POI as shown by the pin on a map.","allOf":[{"$ref":"#/components/schemas/Location"}]},"sideOfStreet":{"description":"Location of the waypoint or destination, relative to the driving direction on the street/road.\n\n**NOTE:** Based on the original waypoint position and `sideOfStreetHint` waypoint property.\n - If `sideOfStreetHint` property is specified, it takes priority in determining the side of street in the response.\n - Nothing is returned in the response in case the side of street is ambiguous (too close to the street),\n or if the position is too far from the street.\n\n* 'left`: The left side of the street in relation to the driving direction of the route.\n* `right`: The right side of the street in relation to the driving direction of the route.\n","type":"string","enum":["left","right"]},"id":{"description":"Identifier of this charging station","type":"string"},"attributes":{"$ref":"#/components/schemas/ChargingConnectorAttributes"},"brand":{"$ref":"#/components/schemas/ChargingStationBrand"},"chargePointOperator":{"$ref":"#/components/schemas/ChargePointOperator"},"matchingEMobilityServiceProviders":{"description":"List of matched E-Mobility Service Providers.\nPopulated only when `ev[eMobilityServiceProviderPreferences]` parameter was\npassed in query.\n\n**Note**:\n* This list reflects the subset of E-Mobility Service Providers supported by the charging station, from the list specified in the request parameter `ev[eMobilityServiceProviderPreferences]`.\n","type":"array","items":{"$ref":"#/components/schemas/EMobilityServiceProvider"}}},"required":["type","location"],"example":{"type":"place","location":{"lat":50.339167,"lng":18.93}}},"DeboardAction":{"description":"An action to disembark a ferry.","type":"object","properties":{"action":{"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","type":"string","enum":["deboard"]},"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":{"description":"Description of the action (e.g. Turn left onto Minna St.).","type":"string"}},"required":["action","duration"]},"DockingStationPlace":{"type":"object","description":"A place represents a docking station for rented vehicles.","properties":{"name":{"description":"Location name","type":"string"},"waypoint":{"description":"If present, this place corresponds to the `via` in the request with the same index.\n\nExample:\n\nIf the request contains `via=&via=`\n* the place corresponding to `` in the response will have `waypoint: 0`\n* the place corresponding to `` in the response will have `waypoint: 1`.\n\nNotes:\n* `waypoint` is not present for `origin` and `destination` places. `origin` and `destination` waypoints can be trivially identified in the response as the `departure` of the first section and the `arrival` of the final section, respectively.\n* `waypoint` is not present for any stops that are added automatically by the router.\n","type":"integer","minimum":0},"type":{"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","type":"string","enum":["dockingStation"]},"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"}]},"displayLocation":{"description":"If present, the display position of this location provided in the request or that of the auto-added waypoint. This is different from the originalLocation and location which are generally expected to be on the navigable road network, i.e., on segments. This coordinate, for example, is the location of the POI as shown by the pin on a map.","allOf":[{"$ref":"#/components/schemas/Location"}]},"sideOfStreet":{"description":"Location of the waypoint or destination, relative to the driving direction on the street/road.\n\n**NOTE:** Based on the original waypoint position and `sideOfStreetHint` waypoint property.\n - If `sideOfStreetHint` property is specified, it takes priority in determining the side of street in the response.\n - Nothing is returned in the response in case the side of street is ambiguous (too close to the street),\n or if the position is too far from the street.\n\n* 'left`: The left side of the street in relation to the driving direction of the route.\n* `right`: The right side of the street in relation to the driving direction of the route.\n","type":"string","enum":["left","right"]}},"required":["type","location"],"example":{"type":"place","location":{"lat":50.339167,"lng":18.93}}},"EVEmpiricalModel":{"description":"Specifies parameters required for calculation of energy consumption for electric vehicles using the Empirical model.","type":"object","properties":{"auxiliaryPowerCurve":{"description":"Function curve specifying power consumed by the vehicle's auxiliary systems as a function of time.\nUse this instead of the single-valued `auxiliaryPowerConsumption` or `auxiliaryConsumption` when auxiliary consumption is not constant.\nEmpirical model uses `auxiliaryConsumption` parameter, while physical model has `auxiliaryPowerConsumption` parameter.\nOnly one of these three different parameters can be set.\n\nWhen using this with the empirical model, please note unit difference with `auxiliaryConsumption`.\n\nThe format of the string is a pipe separated list of number pairs, as follows:\n\n```\n,|,|...|,\n```\n\nwhere time values are strictly increasing non-negative integer values in seconds, representing elapsed driving time since the start of the route, and power values are strictly decreasing non-negative floating point values in watts.\nThe function is piecewise constant, e.g., for any elapsed time in the range `[TIME_0, TIME_1]` the value of the function is `POWER_0`.\nFor time greater than `TIME_N`, the value of the function is `POWER_N`. TIME_0 must be explicitly set to zero.\nThe time in the last pair, `TIME_N`, can be at most 1800 (30 minutes).\n\nAuxiliary consumption applies during stops, including charging stops.\nAt charging stops, power used for charging is reduced by the amount used for auxiliary consumption.\n\nThe list can have a maximum of six `TIME`,`POWER` pairs.\n\n**Note**: When using this feature `departureTime` cannot be set to `any`.\n\n**Note:** This is a **beta** release of this feature and may contain bugs or exhibit unexpected behaviour. Related APIs are subject to change without a deprecation process.\n","type":"string"},"freeFlowSpeedTable":{"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":{"description":"Rate of energy consumed per meter rise in elevation (in Wh/m, i.e., Watt-hours per meter).\n","type":"number","minimum":0},"descent":{"description":"Rate of energy recovered per meter fall in elevation (in Wh/m, i.e., Watt-hours per meter).\n","type":"number","minimum":0},"auxiliaryConsumption":{"description":"Rate of energy (in Wh/s) consumed by the vehicle's auxiliary systems (for example, air conditioning, lights).\nThe value represents the number of Watt-hours consumed per second of travel.\n\nAuxiliary consumption applies during stops, including charging stops.\nAt charging stops, power used for charging is reduced by the amount used for auxiliary consumption.\n","type":"number","minimum":0},"initialCharge":{"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","type":"number","minimum":0,"maximum":1000},"maxCharge":{"description":"Total capacity of the vehicle's battery (in kWh).\n","type":"number","minimum":0,"maximum":1200},"chargingCurve":{"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,,,,...,,\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\nMaximum value of rate must not be greater than 2000 kW. The values of charge in the curve are only validated up to the value of `maxChargeAfterChargingStation` since values outside this range are not used.\nMinimum value of rate must not be less than 7kW. The values of charge in the curve are only validated up to the value of `maxChargeAfterChargingStation` since values outside this range are not used.\n\nThe algorithm calculates a route as the best possible combination of driving and charging\nparts and uses the charging curve to evaluate the most efficent range of\ncharging. For example, if the rate of charging is high at lower levels of battery, but slows down significantly after charging a little, stopping\noften and charging less, but quicker, at each station might be better for the overall route.\nBecause batteries lose charging speed with use, providing a charging curve for the\nexact battery would give more accurate charging time estimate than providing a\ngeneric curve for all batteries of one type.\n","type":"string","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"},"maxChargingVoltage":{"description":"Maximum charging voltage supported by the vehicle's battery (in Volt).\n","type":"number","minimum":0,"maximum":2000},"maxChargingCurrent":{"description":"Maximum charging current supported by the vehicle's battery (in Ampere).\n","type":"number","minimum":0,"maximum":2000},"maxChargeAfterChargingStation":{"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\nThe algorithm calculates a route as the best possible combination of driving and charging\nparts so charging at a charging station does not happen strictly to the value of\nthis parameter. Instead, the algorithm attempts to leave every station with\ndifferent charge levels, and only the best possible combination of charging stations\nand target charge will form the final route.\n\nFor example, if there is a fast but not reachable charging station on the route,\nthe algorithm prefers first to charge at a slower station, but only to a level that enables it\nto reach the fast station. This way it calculates the best possible combination of driving\nand charging parts.\n","type":"number","minimum":0},"minChargeAtChargingStation":{"description":"Minimum charge when arriving at a charging station (in kWh).\nValue must be less than the value of `maxChargeAfterChargingStation`.\n\nThe algorithm calculates a route as the best possible combination of driving and charging\nparts so visiting a charging station is planned not when the remaining charge is close\nto the value of this parameter but when it is part of the best possible charging\nplan for the given route.\n\nFor example, it might prefer charging a still half-full battery at the fast charging station because\nthere are only slower stations later on the route and the remaining charge is not\nenough to reach the destination without charging at all.\n","type":"number","minimum":0},"minChargeAtFirstChargingStation":{"description":"Minimum charge when arriving at first charging station (in kWh).\nValue must be less than the value of `maxChargeAfterChargingStation`.\n\nThis overrides `minChargeAtChargingStation` for the first charging station. If not specified, `minChargeAtChargingStation`\nwill be used for all charging stations, including the first one.\n\nThis is usually used when the current charge is too low to reach a charging station within `minChargeAtChargingStation` limits.\n","type":"number","minimum":0},"minChargeAtDestination":{"description":"Minimum charge at the final route destination (in kWh).\nValue must be less than the value of `maxChargeAfterChargingStation`.\n\nThe algorithm calculates a route as the best possible combination of driving and charging\nparts while making sure that the actual value of the charge at the destination would be close to the\nvalue of this parameter. I.e., the resulting value is expected to be bigger\nthan this parameter's value by no more than 10% of the battery capacity.\n","type":"number","minimum":0},"chargingSetupDuration":{"description":"Time spent (in seconds) after arriving at a charging station but before actually charging\n(for example, time spent for payment processing).\n","type":"integer","format":"int32","minimum":0,"maximum":1800},"maxChargingDuration":{"description":"Maximum time spent (in seconds) at a charging station unless otherwise specified in a user-introduced charging waypoint. Charging waypoint may\nspecify max or min duration, both of which can be higher. (see documentation for the `via` parameter)\n","type":"integer","format":"int32","minimum":1800},"connectorTypes":{"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 \"CCS1\"\n * `iec62196Type2Combo`: Type 2 Combo connector, commonly called \"CCS2\"\n * `chademo`: CHAdeMO connector\n * `tesla`: Deprecated alias for `saeJ3400`. Use `saeJ3400` instead. Cannot be used in combination with `saeJ3400`\n * `saeJ3400`: North American Charging Standard (NACS) connector.\n * `gbtDc`: Guobiao GB/T 20234.3 DC connector\n","type":"string","example":"iec62196Type1Combo,chademo"},"maxPowerAtLowVoltage":{"description":"The maximum power (in kW) at which a vehicle can charge given these conditions:\n* The charging station connector's maximum supply voltage < 800 V.\n* The vehicle's `maxChargingVoltage` >= 800 V.\n\nThe `consumablePower` at a station is then taken to be the lower of `maxPowerAtLowVoltage` and the charging station's available power.\n","type":"number","minimum":0,"default":45},"maxDrivingTimeBeforeCharge":{"description":"The maximum driving time before the first charging stop. This attribute can be used in conjunction with `minTimeAtFirstChargingStation`\nto delay the charging stop and extend it, if required, up to the mandated rest period for the drivers. When this attribute is provided, `minTimeAtFirstChargingStation`\nis also required.\n","type":"number","maximum":18000},"minTimeAtFirstChargingStation":{"description":"The minimum duration at the first charging stop, including the charging time and subsequent waiting time.\nThis attribute can be used as standalone or in conjunction with `maxDrivingTimeBeforeCharge`.\n","type":"number","minimum":1,"maximum":1800}},"required":["freeFlowSpeedTable"]},"ForbiddenHazardousGoods":{"oneOf":[{"$ref":"#/components/schemas/HazardousGoodsRestrictionAny"},{"$ref":"#/components/schemas/HazardousGoodsRestrictionArray"}]},"Fuel":{"description":"**Disclaimer: This parameter is currently in beta release, and is therefore subject to breaking changes.**\n\nFuel parameters to be used for calculating consumption and related CO2 emission, and toll calculation.\n\nThe following attributes are required for calculating consumption:\n * `type`\n * `freeFlowSpeedTable`\n\nThe following attribute is needed for fuel specific toll calculation (if not provided default toll instead of fuel specific toll will be returned):\n * `type`\n\n**Notes**:\n* Hybrid vehicles (EV + Other fuel types) are not supported. Consumption properties are not supported for combination of `ev` and `fuel` vehicles.\n* Fuel parameters are not supported in combination with pedestrian and bicycle `transportMode`.\n","type":"object","properties":{"type":{"description":"Vehicle fuel type (diesel, petrol, lpg, etc.) required for calculation of consumption and CO2 emission for fuel-based vehicles. Also used for toll calculation (if provided) when `vehicle[engineType] is internalCombustion`\n","allOf":[{"$ref":"#/components/schemas/FuelType"}]},"freeFlowSpeedTable":{"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"}]},"additionalConsumption":{"description":"Rate of fuel (in ml/s for diesel, petrol & LPG, gm/s for CNG) consumed by the vehicle for any other reason\nadditional to fuel consumption for speed.\n","type":"number","minimum":0},"ascent":{"description":"Rate of fuel consumed per meter rise in elevation (in ml/m for diesel, petrol & LPG, gm/m for CNG).\n","type":"number","minimum":0}},"required":["type"]},"MatchTrace":{"description":"Trace file with points and path match parameters","type":"object","properties":{"trace":{"type":"array","minItems":2,"maxItems":50000,"items":{"$ref":"#/components/schemas/MatchTracePoint"}},"via":{"type":"array","items":{"$ref":"#/components/schemas/MatchTraceVia"}}},"required":["trace"],"example":{"trace":[{"lat":52,"lng":13.1},{"lat":52.1,"lng":13.2},{"lat":52.2,"lng":13.3}],"via":[{"index":1}]}},"NetworkRestrictedTruckPost":{"description":"**Disclaimer: This parameter is currently in beta release, and is therefore subject to breaking changes.**\n\nParameters specific to the `networkRestrictedTruck` transport mode.\n","type":"object","properties":{"permittedNetworks":{"$ref":"#/components/schemas/PermittedNetworksPost"}}},"PedestrianNotice":{"type":"object","description":"A notice contains important notifications.","properties":{"title":{"type":"string","description":"Human-readable notice description.","example":"Violated avoid tunnel"},"code":{"type":"string","description":"Extensible enum: `simplePolyline` `pedestrianOptionViolated` `violatedAvoidTunnel` `violatedAvoidDirtRoad` `violatedBlockedRoad` `...` \nCurrently known codes (non-exhaustive: this list could be extended for new situations):\n\n| Code | Description | Severity |\n| --------- | ------- | ------- |\n| simplePolyline | An accurate polyline is not available for this section. The returned polyline has been generated from departure and arrival places | info |\n| pedestrianOptionViolated | This section violates the parameter `pedestrian[speed]` or `pedestrian[maxDistance]` | critical |\n| violatedAvoidTunnel | Route did not manage to avoid user preference | critical |\n| violatedAvoidDirtRoad | Route did not manage to avoid user preference | critical |\n| violatedBlockedRoad | Route uses roads that are blocked due to `avoid[areas]` or `avoid[segments]`. | critical |\n","example":"violatedAvoidTunnel","x-extensible-enum":["simplePolyline","pedestrianOptionViolated","violatedAvoidTunnel","violatedAvoidDirtRoad","violatedBlockedRoad"]},"severity":{"$ref":"#/components/schemas/NoticeSeverity"},"details":{"type":"array","description":"Additional details about the notice","items":{"$ref":"#/components/schemas/BaseNoticeDetail"}}},"required":["code"]},"PedestrianSummary":{"type":"object","description":"Total value of key attributes for a route section.","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"}]}},"required":["duration","length"]},"PedestrianTransport":{"type":"object","description":"Information about a transport","properties":{"mode":{"$ref":"#/components/schemas/PedestrianMode"},"name":{"type":"string","description":"Name of the transport, e.g., the name of a ferry or train."}},"required":["mode"]},"Place":{"type":"object","description":"A place represents a generic location relevant for the route.","properties":{"name":{"description":"Location name","type":"string"},"waypoint":{"description":"If present, this place corresponds to the `via` in the request with the same index.\n\nExample:\n\nIf the request contains `via=&via=`\n* the place corresponding to `` in the response will have `waypoint: 0`\n* the place corresponding to `` in the response will have `waypoint: 1`.\n\nNotes:\n* `waypoint` is not present for `origin` and `destination` places. `origin` and `destination` waypoints can be trivially identified in the response as the `departure` of the first section and the `arrival` of the final section, respectively.\n* `waypoint` is not present for any stops that are added automatically by the router.\n","type":"integer","minimum":0},"type":{"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","type":"string","enum":["place"]},"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"}]},"displayLocation":{"description":"If present, the display position of this location provided in the request or that of the auto-added waypoint. This is different from the originalLocation and location which are generally expected to be on the navigable road network, i.e., on segments. This coordinate, for example, is the location of the POI as shown by the pin on a map.","allOf":[{"$ref":"#/components/schemas/Location"}]},"sideOfStreet":{"description":"Location of the waypoint or destination, relative to the driving direction on the street/road.\n\n**NOTE:** Based on the original waypoint position and `sideOfStreetHint` waypoint property.\n - If `sideOfStreetHint` property is specified, it takes priority in determining the side of street in the response.\n - Nothing is returned in the response in case the side of street is ambiguous (too close to the street),\n or if the position is too far from the street.\n\n* 'left`: The left side of the street in relation to the driving direction of the route.\n* `right`: The right side of the street in relation to the driving direction of the route.\n","type":"string","enum":["left","right"]}},"required":["type","location"],"example":{"type":"place","location":{"lat":50.339167,"lng":18.93}}},"RangePrice":{"type":"object","properties":{"type":{"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","type":"string"},"estimated":{"description":"Attribute value is `true` if the fare price is estimated, `false` if it is an exact value.","type":"boolean","default":false},"currency":{"description":"Local currency of the price compliant to ISO 4217","type":"string"},"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":{"description":"Minimum price","type":"number"},"maximum":{"description":"Maximum price","type":"number"}},"required":["type","currency","minimum","maximum"]},"RoadInfo":{"type":"object","description":"Road information attached to an offset action","properties":{"type":{"$ref":"#/components/schemas/RoadInfoType"},"name":{"description":"Name of the road\n\nIf the road has multiple names, each name will be a separate entry in the array.\nThe road names can be in multiple languages. If a preferred language was provided,\nand names in that language are available, they will be prioritized in the array.\nOtherwise the default name of the street is prioritized.\n","type":"array","items":{"$ref":"#/components/schemas/LocalizedString"}},"number":{"description":"Route name or number (e.g. 'M25')","type":"array","items":{"$ref":"#/components/schemas/LocalizedRouteNumber"}},"toward":{"description":"Names of destinations on sign which can be reached when going in that direction","type":"array","items":{"$ref":"#/components/schemas/LocalizedString"}}},"example":{"fennstrasse":{"type":"street","name":[{"value":"Fennstraße","language":"de"}],"number":[{"value":"B96","language":"de"}],"toward":[{"value":"Reinickendorf","language":"de"}]}}},"RouteResponseNoticeDetail":{"description":"Details attached to notices in route response.","oneOf":[{"$ref":"#/components/schemas/ViaNoticeDetail"}],"discriminator":{"propertyName":"type","mapping":{"via":"#/components/schemas/ViaNoticeDetail"}}},"Routing403ErrorResponseSchema":{"type":"object","anyOf":[{"$ref":"#/components/schemas/SimpleErrorResponseSchema"},{"$ref":"#/components/schemas/RoutingErrorResponse"}]},"Routing429ErrorResponseSchema":{"type":"object","anyOf":[{"$ref":"#/components/schemas/SimpleErrorResponseSchema"},{"$ref":"#/components/schemas/RoutingErrorResponse"}]},"SignpostLabelRouteNumber":{"type":"object","description":"Route number on a signpost label. The `routeType` property of the LocalizedRouteNumber is always null at the moment for SignpostLabel, because the data is currently not available.\n","properties":{"routeNumber":{"$ref":"#/components/schemas/LocalizedRouteNumber"}}},"SinglePrice":{"type":"object","properties":{"type":{"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","type":"string"},"estimated":{"description":"Attribute value is `true` if the fare price is estimated, `false` if it is an exact value.","type":"boolean","default":false},"currency":{"description":"Local currency of the price compliant to ISO 4217","type":"string"},"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":{"description":"The price value","type":"number"}},"required":["type","currency","value"]},"StationPlace":{"type":"object","description":"A station","properties":{"name":{"description":"Location name","type":"string"},"waypoint":{"description":"If present, this place corresponds to the `via` in the request with the same index.\n\nExample:\n\nIf the request contains `via=&via=`\n* the place corresponding to `` in the response will have `waypoint: 0`\n* the place corresponding to `` in the response will have `waypoint: 1`.\n\nNotes:\n* `waypoint` is not present for `origin` and `destination` places. `origin` and `destination` waypoints can be trivially identified in the response as the `departure` of the first section and the `arrival` of the final section, respectively.\n* `waypoint` is not present for any stops that are added automatically by the router.\n","type":"integer","minimum":0},"type":{"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","type":"string","enum":["station"]},"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"}]},"displayLocation":{"description":"If present, the display position of this location provided in the request or that of the auto-added waypoint. This is different from the originalLocation and location which are generally expected to be on the navigable road network, i.e., on segments. This coordinate, for example, is the location of the POI as shown by the pin on a map.","allOf":[{"$ref":"#/components/schemas/Location"}]},"sideOfStreet":{"description":"Location of the waypoint or destination, relative to the driving direction on the street/road.\n\n**NOTE:** Based on the original waypoint position and `sideOfStreetHint` waypoint property.\n - If `sideOfStreetHint` property is specified, it takes priority in determining the side of street in the response.\n - Nothing is returned in the response in case the side of street is ambiguous (too close to the street),\n or if the position is too far from the street.\n\n* 'left`: The left side of the street in relation to the driving direction of the route.\n* `right`: The right side of the street in relation to the driving direction of the route.\n","type":"string","enum":["left","right"]},"id":{"description":"Identifier of this station","type":"string"},"platform":{"description":"Platform name or number for the departure.","type":"string"},"code":{"description":"Short text or a number that identifies the place for riders.","type":"string"},"wheelchairAccessible":{"description":"Information about accessibility for people with a disability and who use a wheelchair.\n\n* `unknown` - Accessibility information is not available.\n* `yes` - There exists some accessible path from outside the station to the specific stop/platform.\n* `limited` - Accessibility is limited or assistance is required.\n* `no` - There exists no accessible path from outside the station to the specific stop/platform.\n","allOf":[{"$ref":"#/components/schemas/WheelchairAccessibility"}]}},"required":["type","location"],"example":{"type":"place","location":{"lat":50.339167,"lng":18.93}}},"TransitSpan":{"type":"object","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","properties":{"offset":{"description":"Offset of a coordinate in the section's polyline.\n","type":"integer","format":"int32","minimum":0},"length":{"description":"Length of the span.\n","allOf":[{"$ref":"#/components/schemas/Distance"}]},"duration":{"description":"Duration of the span.","allOf":[{"$ref":"#/components/schemas/Duration"}]},"countryCode":{"$ref":"#/components/schemas/CountryCode"},"stateCode":{"$ref":"#/components/schemas/StateCode"},"names":{"description":"Designated name for the span (e.g. a street name or a transport name)","type":"array","items":{"$ref":"#/components/schemas/LocalizedString"}},"segmentId":{"description":"**NOTE:** Attribute segmentId is deprecated. Use segmentRef instead.\n\nThe directed topology segment id including prefix (e.g '+here:cm:segment:').\n\nThe id consists of two parts.\n* The direction ('+' or '-')\n* followed by the topology segment id (a unique identifier within the HERE platform catalogs).\n\nThe direction specifies whether the route is using the segment in its canonical direction ('+' aka traveling along the geometry's direction), or against it ('-' aka traveling against the geometry's direction).\n\nThis attribute will not appear for HERE Public Transit v8 and HERE Intermodal Routing v8 requests\n","type":"string","deprecated":true},"segmentRef":{"$ref":"#/components/schemas/SegmentRef"},"notices":{"description":"A list of indexes into the notices array of the parent section.\nReferences all notices that apply to the span.\n","type":"array","items":{"type":"integer"}}}},"TransitTransport":{"type":"object","description":"Transit transport information.","properties":{"mode":{"$ref":"#/components/schemas/TransitMode"},"name":{"type":"string","description":"Transit line name","example":"U2"},"headsign":{"description":"Transit line headsign","type":"string"},"category":{"description":"Human readable transport category (such as Bus, Gondola, Tram, Train, ...)","type":"string","example":"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"}]},"shortName":{"description":"Short name of a transit line.","type":"string","example":"U2"},"longName":{"description":"Long name of a transit line.","type":"string","example":"Pankow - Ruhleben"}},"required":["mode"]},"Truck":{"type":"object","description":"Vehicle-specific parameters","properties":{"shippedHazardousGoods":{"description":"Hazardous goods restrictions refer to the limitations and regulations imposed on the transportation of specific types of hazardous materials during a trip.\n\nA comma-separated list of hazardous goods being shipped in the vehicle. The following values are possible:\n\n* `explosive`: Materials that are capable of causing an explosion.\n* `gas`: Gas (definition varies from country to country). For details, check [here](https://en.wikipedia.org/wiki/HAZMAT_Class_2_Gases).\n* `flammable`: Materials that are easily ignited and capable of catching fire.\n* `combustible`: Materials that have the potential to burn or catch fire.\n* `organic`: Materials derived from living organisms or containing carbon compounds.\n* `poison`: Substances that can cause harm or death when ingested, inhaled, or absorbed.\n* `radioactive`: Materials that emit radiation and pose potential health risks.\n* `corrosive`: Substances that can cause damage or destruction through chemical reactions.\n* `poisonousInhalation`: Materials that are toxic when inhaled.\n* `harmfulToWater`: Materials that can cause pollution or harm to water bodies.\n* `other`: Other types of hazardous materials not covered by the above categories.\n\n**Note:** Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n","type":"string","example":"explosive,gas,flammable"},"grossWeight":{"description":"Gross vehicle weight, including trailers and shipped goods when loaded at capacity, specified in kilograms.\n\nIf unspecified, it will default to currentWeight. If neither parameter has a value specified, it will default to 0.\n\n**Notes:**\n* Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n* Maximum weight for a car or taxi _without_ a trailer is 4250 kg.\n* Maximum weight for a car or taxi _with_ a trailer is 7550 kg.\n","type":"integer","format":"int32","minimum":0},"currentWeight":{"description":"Current vehicle weight, including trailers and shipped goods currently loaded, specified in kilograms.\n\nIf unspecified, it will default to grossWeight. If neither parameter has a value specified, it will default to 0.\n\n**Notes:**\n* Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n* Maximum weight for a car or taxi _without_ a trailer is 5000 kg.\n* Maximum weight for a car or taxi _with_ a trailer is 8500 kg.\n* A route request with `currentWeight` above `grossWeight` may result in non-compliant or invalid routes.\n","type":"integer","format":"int32","minimum":0},"emptyWeight":{"description":"Empty weight of the vehicle combination ready to be driven, including necessary fluids and equipment\ndetermined by the local regulations, specified in kilograms.\n\n**Note:**\n* Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n* Maximum weight for a car or taxi _without_ a trailer is 4250 kg.\n* Maximum weight for a car or taxi _with_ a trailer is 7550 kg.\n","type":"integer","format":"int32","minimum":0},"weightPerAxle":{"description":"Heaviest vehicle weight-per-axle, specified in kilograms.\n\nHeaviest weight-per-axle, regardless of axle-type or axle-group. It is evaluated against\nall axle-weight restrictions, including single-axle and tandem-axle weight restrictions.\nIt is useful if differences between axle types, like tandem and triple axles, are not\nrelevant. This is the case in many countries, since they don't distinguish between these\ndifferent axle groups on signs and in regulations.\n\nMore fine-grained axle weight input is possible with `weightPerAxleGroup`.\n\n**Note:** `weightPerAxleGroup` and `weightPerAxle` are incompatible.\n\n**Note:** Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n","type":"integer","format":"int32","minimum":0},"weightPerAxleGroup":{"$ref":"#/components/schemas/WeightPerAxleGroup"},"height":{"description":"Vehicle height, specified in centimeters.\n\n**Note:** Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n","type":"integer","format":"int32","minimum":0,"maximum":5000},"width":{"description":"Vehicle width, specified in centimeters.\n\n**Note:** Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n","type":"integer","format":"int32","minimum":0,"maximum":5000},"length":{"description":"Total vehicle length, including all trailers, specified in centimeters.\n\n**Note:** Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n","type":"integer","format":"int32","minimum":0,"maximum":30000},"kpraLength":{"description":"Kingpin to rear axle length, in centimeters.\n\n**NOTE:** Currently, the KPRA restrictions are only present in California and Idaho.\n\n**Note:** Supported in `truck`, `car` (Beta), `taxi` (Beta) transport modes.\n","type":"integer","format":"int32","minimum":0},"trailerLength":{"description":"Length of the longest trailer, specified in centimeters.\n\n**Note:** Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n","type":"integer","format":"int32","minimum":0,"maximum":2000},"payloadCapacity":{"description":"Allowed payload capacity, including trailers, specified in kilograms.\n\n**Note:** Supported in `truck`, `car` (Beta), `taxi` (Beta) transport modes.\n","type":"integer","format":"int32","minimum":0},"tunnelCategory":{"description":"Specifies the [cargo tunnel restriction code](https://adrbook.com/en/2017/ADR/8.6.3). Route will pass only through tunnels of less restrictive categories.\n\n**Note:** Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n","allOf":[{"$ref":"#/components/schemas/TunnelCategory"}]},"axleCount":{"description":"Specifies the total number of axles the vehicle has, i.e., axles on the base vehicle and any attached trailers.\n\n**Note:** Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n","type":"integer","format":"int32","minimum":2,"maximum":255},"trailerAxleCount":{"description":"Specifies the total number of axles across all the trailers attached to the vehicle.\nThis number is included in `axleCount`, hence `trailerAxleCount` must be strictly less than `axleCount`.\n`trailerCount` must be non-zero.\n\n**Note:** This parameter is currently used only for the calculation of tolls in regions where it is applicable.\n","type":"integer","format":"int32","minimum":1},"tiresCount":{"description":"Specifies the total number of tires the vehicle has, i.e., the tires on the base vehicle and any attached trailers.\n","type":"integer","format":"int32","minimum":1,"maximum":255},"category":{"description":"Specifies the category of the vehicle. The supported values are:\n\n* `undefined`: The vehicle category is undefined, and no special considerations are taken into\n account. Vehicle routing will proceed as normal.\n* `lightTruck`: The vehicle is a truck light enough to be classified more as a car than as a truck.\n This exempts it from many legal restrictions for normal trucks. However, restrictions related to the physical dimensions of the truck or its cargo still apply.\n\n For more details, refer to [Truck categories](https://docs.here.com/routing/docs/routing-v8-truck-routing#truck-categories).\n\n **Note:** Supported only in `truck` transport mode.\n","type":"string","enum":["undefined","lightTruck"],"default":"undefined"},"trailerCount":{"description":"The number of trailers attached to the vehicle.\n\nMaximum value when used with `transportMode=car` or `transportMode=taxi` is 1.\n\n**Limitations:** Considered for route calculation when `transportMode` is one of (`truck`, `bus`, `privateBus`). Considered for route calculation for restrictions, but not for speed limits, when `transportMode` is `car` or `taxi`.\n","type":"integer","format":"int32","minimum":0,"maximum":255,"default":0},"hovOccupancy":{"description":"**Note**: This parameter is deprecated, `vehicle[occupancy]` and `allow[hov]` should be used instead.\nThe number of occupants in the vehicle, defined as individuals occupying a seat with a restraint device.\nThis value affects the ability of the router to use HOV (High-Occupancy Vehicles) restricted lanes.\n\nLimitations:\n * Any value over 1 is interpreted as the ability to use any HOV lane, including those restricted to 3+ passengers.\n","type":"integer","minimum":1,"default":1,"deprecated":true},"licensePlate":{"description":"Specifies the information about the vehicle's license plate number.\nThis information is used to evaluate whether certain vehicle restrictions in environmental zones apply.\nCurrently, only the last character of the license plate can be provided.\n\nFormat: `lastCharacter:{character}`\n\nExample: `lastCharacter:2`\n","type":"string"},"speedCap":{"description":"Specifies the maximum speed, in meters per second (m/s), that the user wishes not to exceed.\nThis parameter affects the route's estimated time of arrival (ETA) and consumption calculation.\n\nLimitations:\n * valid for following transport modes: `car`, `truck`, `scooter`, `taxi`, `bus`, and `privateBus`\n\nNotes:\n * Car and Truck mode updates route ETA.\n * Scooter mode updates route optimization and ETA.\n * Resulting ETA can not be decreased by this parameter.\n","type":"number","minimum":1,"maximum":70},"speedCapPerFc":{"description":"A comma separated list of speeds in meters per second (m/s) specifying the maximum speed per FC (Functional Class, as defined in the `FunctionalClass` schema) that the user wishes not to exceed.\nThe list can have up to 5 entries, corresponding to FC 1 to FC 5. Empty entries indicate that no speed cap is specified for the corresponding FC.\nThis parameter affects the route's estimated time of arrival (ETA) and consumption calculation.\n\nLimitations:\n * valid for following transport modes: `car`, `truck`\n\nValues limitations:\n * minimum: 1.00\n * maximum: 70.00\n\nExamples:\n * `vehicle[speedCapPerFc]=20,16.7,14,11,8` - specify limits for all FCs\n * `vehicle[speedCapPerFc]=20,16.7,,11,8` - specify limits for all FCs except for FC 3\n * `vehicle[speedCapPerFc]=20,16.7,14` - specify limits for FC 1, 2 and 3\n\nNotes:\n * Resulting ETA can not be decreased by this parameter.\n * vehicle[speedCapPerFc] and vehicle[speedCap] may be used in combination. For FCs where both values are specified, the minimum value is used.\n","type":"string"},"engineSizeCc":{"description":"Specifies the engine size of the vehicle in cubic centimeters.\nCurrently, the value is used only in scooter mode.\nThis parameter is utilized to determine if the scooter can be classified as a moped.\nScooters with an engine size less than 51cc are considered mopeds.\n**Alpha**: This API is in development. It may not be stable and is subject to change. It may have no impact on response.\n","type":"integer","minimum":0,"maximum":2000},"occupancy":{"description":"The number of occupants on the vehicle, defined as individuals occupying a seat.\nThis value affects the ability of the router to use HOV (High-Occupancy Vehicles) restricted lanes. If not set and `allow[hov]=true` is set, then occupancy requirements for all HOV conditions are considered to be met.\nThis parameter also affects scooter occupancy restrictions. If not set, occupancy restrictions for scooters are ignored.\n\nThe parameter is also used for calculating the toll cost, in cases where the toll-cost for the vehicle depends on the passenger count. If not set, occupancy of 1 is assumed for toll calculation.\n\n**Note:**: This parameter can't be used with 'vehicle[hovOccupancy]'.\n","type":"integer","minimum":1},"engineType":{"description":"Specifies the engine type of the vehicle.\n\n**Limitations:** Currently this parameter is used only for toll calculation. It may be used at any point for route calculation (for example, to automatically avoid environmental zones).\n\n**Note:**\n * If engineType is specified as `internalCombustion`, valid `fuel[type]` should also be provided to get fuel specific toll. If `fuel[type]` is not provided, default toll without considering `fuel[type]` will be returned.\n * If `ev` or `fuel` namespace parameters are provided with an incompatible `engineType` (e.g. engineType=internalCombustion is provided along with `ev` namespace parameters) then `ev` namespace will override `engineType` and incompatible `engineType` will be ignored for toll, consumption, and emission computations.\n","type":"string","enum":["electric","pluginHybrid","internalCombustion"]},"heightAboveFirstAxle":{"description":"Height of the vehicle above its first axle, in centimeters.\n\n**Note:** This parameter is currently used only for the calculation of tolls in regions where it is applicable.\n","type":"integer","format":"int32","minimum":0,"maximum":5000},"frontalArea":{"description":"Frontal area represents the total cross section area of the vehicle as viewed from the front, specified in square meters. Physical consumption model is using this value in combination with `airDragCoefficient` to calculate the consumption caused by air resistance.\n**Note:** This attribute, or both `width` and `height`, is required when using the physical model `consumptionModel=physical` for EV consumption.\n","type":"number","minimum":0.5,"maximum":50},"rollingResistanceCoefficient":{"description":"Rolling resistance refers to the resistance experienced by your vehicle tire as it rolls over a surface. The main causes of this resistance are tire deformation, wing drag, and friction with the ground. The coefficient of rolling resistance is a numerical value indicating the severity of this factor.\n**Note:** This attribute is required when using the physical model `consumptionModel=physical` for EV consumption.\n","type":"number","exclusiveMinimum":true,"minimum":0.001,"maximum":0.5},"airDragCoefficient":{"description":"The drag coefficient of an vehicle defines the way the vehicle is expected to pass through the surrounding air. More streamlined vehicles are more aerodynamic and therefore have smaller drag coefficient.\n**Note:** This attribute is required when using the physical model `consumptionModel=physical` for EV consumption.\n","type":"number","exclusiveMinimum":true,"minimum":0.1,"maximum":1},"commercial":{"description":"Specifies whether the vehicle is a commercial or a non-commercial vehicle.\n\nUsed for toll costs, speed limits and accessing delivery areas.\n\n* By default, trucks are considered commercial vehicles, while all other transport modes are considered non-commercial. Though, if left unspecified, the toll cost best fitting the vehicle profile is reported, irrespective of commercial use.\n* For commercial cars, commercial speed limits apply, which may differ from speed limits for passenger cars.\n* Commercial cars can enter delivery areas, similarly to trucks.\n* For examples and limitations see [Developer Guide](https://docs.here.com/routing/docs/routing-v8-light-commercial-vehicle-routing)\n\n**Note:** supported in `car`, `truck`, `bus`, `privateBus` and `taxi`.\n","type":"boolean"},"type":{"$ref":"#/components/schemas/TruckTypeWithDefault"}},"deprecated":true},"Vehicle":{"type":"object","description":"Vehicle-specific parameters","properties":{"shippedHazardousGoods":{"description":"Hazardous goods restrictions refer to the limitations and regulations imposed on the transportation of specific types of hazardous materials during a trip.\n\nA comma-separated list of hazardous goods being shipped in the vehicle. The following values are possible:\n\n* `explosive`: Materials that are capable of causing an explosion.\n* `gas`: Gas (definition varies from country to country). For details, check [here](https://en.wikipedia.org/wiki/HAZMAT_Class_2_Gases).\n* `flammable`: Materials that are easily ignited and capable of catching fire.\n* `combustible`: Materials that have the potential to burn or catch fire.\n* `organic`: Materials derived from living organisms or containing carbon compounds.\n* `poison`: Substances that can cause harm or death when ingested, inhaled, or absorbed.\n* `radioactive`: Materials that emit radiation and pose potential health risks.\n* `corrosive`: Substances that can cause damage or destruction through chemical reactions.\n* `poisonousInhalation`: Materials that are toxic when inhaled.\n* `harmfulToWater`: Materials that can cause pollution or harm to water bodies.\n* `other`: Other types of hazardous materials not covered by the above categories.\n\n**Note:** Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n","type":"string","example":"explosive,gas,flammable"},"grossWeight":{"description":"Gross vehicle weight, including trailers and shipped goods when loaded at capacity, specified in kilograms.\n\nIf unspecified, it will default to currentWeight. If neither parameter has a value specified, it will default to 0.\n\n**Notes:**\n* Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n* Maximum weight for a car or taxi _without_ a trailer is 4250 kg.\n* Maximum weight for a car or taxi _with_ a trailer is 7550 kg.\n","type":"integer","format":"int32","minimum":0},"currentWeight":{"description":"Current vehicle weight, including trailers and shipped goods currently loaded, specified in kilograms.\n\nIf unspecified, it will default to grossWeight. If neither parameter has a value specified, it will default to 0.\n\n**Notes:**\n* Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n* Maximum weight for a car or taxi _without_ a trailer is 5000 kg.\n* Maximum weight for a car or taxi _with_ a trailer is 8500 kg.\n* A route request with `currentWeight` above `grossWeight` may result in non-compliant or invalid routes.\n","type":"integer","format":"int32","minimum":0},"emptyWeight":{"description":"Empty weight of the vehicle combination ready to be driven, including necessary fluids and equipment\ndetermined by the local regulations, specified in kilograms.\n\n**Note:**\n* Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n* Maximum weight for a car or taxi _without_ a trailer is 4250 kg.\n* Maximum weight for a car or taxi _with_ a trailer is 7550 kg.\n","type":"integer","format":"int32","minimum":0},"weightPerAxle":{"description":"Heaviest vehicle weight-per-axle, specified in kilograms.\n\nHeaviest weight-per-axle, regardless of axle-type or axle-group. It is evaluated against\nall axle-weight restrictions, including single-axle and tandem-axle weight restrictions.\nIt is useful if differences between axle types, like tandem and triple axles, are not\nrelevant. This is the case in many countries, since they don't distinguish between these\ndifferent axle groups on signs and in regulations.\n\nMore fine-grained axle weight input is possible with `weightPerAxleGroup`.\n\n**Note:** `weightPerAxleGroup` and `weightPerAxle` are incompatible.\n\n**Note:** Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n","type":"integer","format":"int32","minimum":0},"weightPerAxleGroup":{"$ref":"#/components/schemas/WeightPerAxleGroup"},"height":{"description":"Vehicle height, specified in centimeters.\n\n**Note:** Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n","type":"integer","format":"int32","minimum":0,"maximum":5000},"width":{"description":"Vehicle width, specified in centimeters.\n\n**Note:** Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n","type":"integer","format":"int32","minimum":0,"maximum":5000},"length":{"description":"Total vehicle length, including all trailers, specified in centimeters.\n\n**Note:** Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n","type":"integer","format":"int32","minimum":0,"maximum":30000},"kpraLength":{"description":"Kingpin to rear axle length, in centimeters.\n\n**NOTE:** Currently, the KPRA restrictions are only present in California and Idaho.\n\n**Note:** Supported in `truck`, `car` (Beta), `taxi` (Beta) transport modes.\n","type":"integer","format":"int32","minimum":0},"trailerLength":{"description":"Length of the longest trailer, specified in centimeters.\n\n**Note:** Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n","type":"integer","format":"int32","minimum":0,"maximum":2000},"payloadCapacity":{"description":"Allowed payload capacity, including trailers, specified in kilograms.\n\n**Note:** Supported in `truck`, `car` (Beta), `taxi` (Beta) transport modes.\n","type":"integer","format":"int32","minimum":0},"tunnelCategory":{"description":"Specifies the [cargo tunnel restriction code](https://adrbook.com/en/2017/ADR/8.6.3). Route will pass only through tunnels of less restrictive categories.\n\n**Note:** Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n","allOf":[{"$ref":"#/components/schemas/TunnelCategory"}]},"axleCount":{"description":"Specifies the total number of axles the vehicle has, i.e., axles on the base vehicle and any attached trailers.\n\n**Note:** Supported in `truck`, `bus`, `privateBus`, `car` (Beta), `taxi` (Beta) transport modes.\n","type":"integer","format":"int32","minimum":2,"maximum":255},"trailerAxleCount":{"description":"Specifies the total number of axles across all the trailers attached to the vehicle.\nThis number is included in `axleCount`, hence `trailerAxleCount` must be strictly less than `axleCount`.\n`trailerCount` must be non-zero.\n\n**Note:** This parameter is currently used only for the calculation of tolls in regions where it is applicable.\n","type":"integer","format":"int32","minimum":1},"tiresCount":{"description":"Specifies the total number of tires the vehicle has, i.e., the tires on the base vehicle and any attached trailers.\n","type":"integer","format":"int32","minimum":1,"maximum":255},"category":{"description":"Specifies the category of the vehicle. The supported values are:\n\n* `undefined`: The vehicle category is undefined, and no special considerations are taken into\n account. Vehicle routing will proceed as normal.\n* `lightTruck`: The vehicle is a truck light enough to be classified more as a car than as a truck.\n This exempts it from many legal restrictions for normal trucks. However, restrictions related to the physical dimensions of the truck or its cargo still apply.\n\n For more details, refer to [Truck categories](https://docs.here.com/routing/docs/routing-v8-truck-routing#truck-categories).\n\n **Note:** Supported only in `truck` transport mode.\n","type":"string","enum":["undefined","lightTruck"],"default":"undefined"},"trailerCount":{"description":"The number of trailers attached to the vehicle.\n\nMaximum value when used with `transportMode=car` or `transportMode=taxi` is 1.\n\n**Limitations:** Considered for route calculation when `transportMode` is one of (`truck`, `bus`, `privateBus`). Considered for route calculation for restrictions, but not for speed limits, when `transportMode` is `car` or `taxi`.\n","type":"integer","format":"int32","minimum":0,"maximum":255,"default":0},"hovOccupancy":{"description":"**Note**: This parameter is deprecated, `vehicle[occupancy]` and `allow[hov]` should be used instead.\nThe number of occupants in the vehicle, defined as individuals occupying a seat with a restraint device.\nThis value affects the ability of the router to use HOV (High-Occupancy Vehicles) restricted lanes.\n\nLimitations:\n * Any value over 1 is interpreted as the ability to use any HOV lane, including those restricted to 3+ passengers.\n","type":"integer","minimum":1,"default":1,"deprecated":true},"licensePlate":{"description":"Specifies the information about the vehicle's license plate number.\nThis information is used to evaluate whether certain vehicle restrictions in environmental zones apply.\nCurrently, only the last character of the license plate can be provided.\n\nFormat: `lastCharacter:{character}`\n\nExample: `lastCharacter:2`\n","type":"string"},"speedCap":{"description":"Specifies the maximum speed, in meters per second (m/s), that the user wishes not to exceed.\nThis parameter affects the route's estimated time of arrival (ETA) and consumption calculation.\n\nLimitations:\n * valid for following transport modes: `car`, `truck`, `scooter`, `taxi`, `bus`, and `privateBus`\n\nNotes:\n * Car and Truck mode updates route ETA.\n * Scooter mode updates route optimization and ETA.\n * Resulting ETA can not be decreased by this parameter.\n","type":"number","minimum":1,"maximum":70},"speedCapPerFc":{"description":"A comma separated list of speeds in meters per second (m/s) specifying the maximum speed per FC (Functional Class, as defined in the `FunctionalClass` schema) that the user wishes not to exceed.\nThe list can have up to 5 entries, corresponding to FC 1 to FC 5. Empty entries indicate that no speed cap is specified for the corresponding FC.\nThis parameter affects the route's estimated time of arrival (ETA) and consumption calculation.\n\nLimitations:\n * valid for following transport modes: `car`, `truck`\n\nValues limitations:\n * minimum: 1.00\n * maximum: 70.00\n\nExamples:\n * `vehicle[speedCapPerFc]=20,16.7,14,11,8` - specify limits for all FCs\n * `vehicle[speedCapPerFc]=20,16.7,,11,8` - specify limits for all FCs except for FC 3\n * `vehicle[speedCapPerFc]=20,16.7,14` - specify limits for FC 1, 2 and 3\n\nNotes:\n * Resulting ETA can not be decreased by this parameter.\n * vehicle[speedCapPerFc] and vehicle[speedCap] may be used in combination. For FCs where both values are specified, the minimum value is used.\n","type":"string"},"engineSizeCc":{"description":"Specifies the engine size of the vehicle in cubic centimeters.\nCurrently, the value is used only in scooter mode.\nThis parameter is utilized to determine if the scooter can be classified as a moped.\nScooters with an engine size less than 51cc are considered mopeds.\n**Alpha**: This API is in development. It may not be stable and is subject to change. It may have no impact on response.\n","type":"integer","minimum":0,"maximum":2000},"occupancy":{"description":"The number of occupants on the vehicle, defined as individuals occupying a seat.\nThis value affects the ability of the router to use HOV (High-Occupancy Vehicles) restricted lanes. If not set and `allow[hov]=true` is set, then occupancy requirements for all HOV conditions are considered to be met.\nThis parameter also affects scooter occupancy restrictions. If not set, occupancy restrictions for scooters are ignored.\n\nThe parameter is also used for calculating the toll cost, in cases where the toll-cost for the vehicle depends on the passenger count. If not set, occupancy of 1 is assumed for toll calculation.\n\n**Note:**: This parameter can't be used with 'vehicle[hovOccupancy]'.\n","type":"integer","minimum":1},"engineType":{"description":"Specifies the engine type of the vehicle.\n\n**Limitations:** Currently this parameter is used only for toll calculation. It may be used at any point for route calculation (for example, to automatically avoid environmental zones).\n\n**Note:**\n * If engineType is specified as `internalCombustion`, valid `fuel[type]` should also be provided to get fuel specific toll. If `fuel[type]` is not provided, default toll without considering `fuel[type]` will be returned.\n * If `ev` or `fuel` namespace parameters are provided with an incompatible `engineType` (e.g. engineType=internalCombustion is provided along with `ev` namespace parameters) then `ev` namespace will override `engineType` and incompatible `engineType` will be ignored for toll, consumption, and emission computations.\n","type":"string","enum":["electric","pluginHybrid","internalCombustion"]},"heightAboveFirstAxle":{"description":"Height of the vehicle above its first axle, in centimeters.\n\n**Note:** This parameter is currently used only for the calculation of tolls in regions where it is applicable.\n","type":"integer","format":"int32","minimum":0,"maximum":5000},"frontalArea":{"description":"Frontal area represents the total cross section area of the vehicle as viewed from the front, specified in square meters. Physical consumption model is using this value in combination with `airDragCoefficient` to calculate the consumption caused by air resistance.\n**Note:** This attribute, or both `width` and `height`, is required when using the physical model `consumptionModel=physical` for EV consumption.\n","type":"number","minimum":0.5,"maximum":50},"rollingResistanceCoefficient":{"description":"Rolling resistance refers to the resistance experienced by your vehicle tire as it rolls over a surface. The main causes of this resistance are tire deformation, wing drag, and friction with the ground. The coefficient of rolling resistance is a numerical value indicating the severity of this factor.\n**Note:** This attribute is required when using the physical model `consumptionModel=physical` for EV consumption.\n","type":"number","exclusiveMinimum":true,"minimum":0.001,"maximum":0.5},"airDragCoefficient":{"description":"The drag coefficient of an vehicle defines the way the vehicle is expected to pass through the surrounding air. More streamlined vehicles are more aerodynamic and therefore have smaller drag coefficient.\n**Note:** This attribute is required when using the physical model `consumptionModel=physical` for EV consumption.\n","type":"number","exclusiveMinimum":true,"minimum":0.1,"maximum":1},"commercial":{"description":"Specifies whether the vehicle is a commercial or a non-commercial vehicle.\n\nUsed for toll costs, speed limits and accessing delivery areas.\n\n* By default, trucks are considered commercial vehicles, while all other transport modes are considered non-commercial. Though, if left unspecified, the toll cost best fitting the vehicle profile is reported, irrespective of commercial use.\n* For commercial cars, commercial speed limits apply, which may differ from speed limits for passenger cars.\n* Commercial cars can enter delivery areas, similarly to trucks.\n* For examples and limitations see [Developer Guide](https://docs.here.com/routing/docs/routing-v8-light-commercial-vehicle-routing)\n\n**Note:** supported in `car`, `truck`, `bus`, `privateBus` and `taxi`.\n","type":"boolean"},"type":{"$ref":"#/components/schemas/VehicleType"}}},"VehicleTransport":{"type":"object","description":"Information about a transport","properties":{"mode":{"$ref":"#/components/schemas/VehicleMode"},"name":{"type":"string","description":"Name of the transport, e.g., the name of a ferry or train."},"currentWeight":{"description":"Contains the value of `vehicle[currentWeight]` used for the section.\nValue expressed in kilograms.\nIf `currentWeightChange` was specified for any of the via waypoints, the value is updated for the remaining sections.\n","type":"integer","format":"int32"}},"required":["mode"]},"ViolatedZoneReference":{"description":"Provides details about the zone associated with `violatedZoneRestriction` and\nthe violated restriction conditions that were evaluated against parameter values\nset in the routing request (such as vehicle properties).\n\nThe restriction is violated only if all of the conditions present are met.\n","type":"object","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","enum":["zoneReference"]},"routingZoneRef":{"$ref":"#/components/schemas/RoutingZoneReference"},"timeDependent":{"type":"boolean","description":"Indicates if the violation is time-dependent"},"restrictedTimes":{"$ref":"#/components/schemas/TimeDomain"},"licensePlateRestriction":{"$ref":"#/components/schemas/LicensePlateRestriction"},"maxWeight":{"$ref":"#/components/schemas/VehicleRestrictionMaxWeight"}},"required":["type"]},"WaitAction":{"description":"A wait operation to be performed at or during a specific portion of a section.\n","type":"object","properties":{"action":{"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","type":"string","enum":["wait"]},"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":{"description":"Description of the action (e.g. Turn left onto Minna St.).","type":"string"}},"required":["action","duration"]},"WebLinkWithDeviceType":{"type":"object","description":"The URL address to an external resource.","properties":{"id":{"description":"Unique identifier for the web link. It is used to deduplicate links defined in multiple sections.","type":"string"},"href":{"$ref":"#/components/schemas/Uri"},"text":{"description":"Text describing the url address (e.g. The example website).","type":"string"},"hrefText":{"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":"string"},"deviceType":{"description":"Extensible enum: `web` `ios` `android` `...` \nDevice type for which the link is intended\n","type":"string","x-extensible-enum":["web","ios","android"]}},"required":["id","text"],"example":{"id":"88-7568-21.07.2023","text":"Information for public transit provided by ThePublicTransit GmbH"}},"EVConsumption":{"description":"EV properties to be used for calculating consumption.\n\nThere are two consumption models (`empirical`, `physical`). Set the `consumptionModel` parameter to choose which model to use.\n\nRequired `empirical` model properties:\n* `freeFlowSpeedTable`\n\nRequired `physical` model properties:\n* `driveEfficiency`\n* `recuperationEfficiency`\n\nWhen using the physical model, certain properties of the `vehicle` parameter are also required (see documentation for the `vehicle` parameter for more details):\n* `rollingResistanceCoefficient`\n* `airDragCoefficient`\n* `currentWeight`\n* `frontalArea` or combination of `width` and `height`\n\nThe following `ev` properties are additionally required in order to calculate State-of-Charge along the route:\n* `initialCharge`\n* `maxCharge`\n\nRoute reachability based on State-of-Charge will be evaluated for the following constraints, if additionally provided,\n* `minChargeAtDestination`\n* `minChargeAtFirstChargingStation`\n* `minChargeAtChargingStation`\n\nThe following properties are additionally required in order to calculate charging at charging station waypoints (see documentation for `via` parameter)\n* `chargingCurve`\n\n**Notes**:\n* Hybrid vehicles (EV + Other fuel types) are not supported. Consumption properties are not supported for combination of `ev` and `fuel` vehicles.\n* EV parameters are not supported in combination with pedestrian, bicycle and network restricted truck `transportMode`.\n","oneOf":[{"$ref":"#/components/schemas/EVEmpiricalModel"},{"$ref":"#/components/schemas/EVPhysicalModel"}]},"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":{"type":"object","description":"Describes a location and time the section is passing through.","properties":{"place":{"$ref":"#/components/schemas/Place"},"offset":{"description":"Passthrough offsets are the coordinate index in the polyline.","type":"number"}},"required":["place"]},"PedestrianPostAction":{"oneOf":[{"$ref":"#/components/schemas/WaitAction"}],"discriminator":{"propertyName":"action","mapping":{"wait":"#/components/schemas/WaitAction"}}},"PedestrianSpan":{"type":"object","description":"Span attached to a `Section` describing pedestrian content.\n","properties":{"offset":{"description":"Offset of a coordinate in the section's polyline.\n","type":"integer","format":"int32","minimum":0},"length":{"description":"Length of the span.\n","allOf":[{"$ref":"#/components/schemas/Distance"}]},"duration":{"description":"Duration of the span.","allOf":[{"$ref":"#/components/schemas/Duration"}]},"streetAttributes":{"description":"`StreetAttributes` is applied to a span of a route section and describes attribute flags of a street. The following flags can be assigned:\n* `rightDrivingSide`: Vehicles must drive on the right-hand side of the road in this part of the route.\n* `dirtRoad`: This part of the route has an unpaved surface, such as a gravel or dirt road.\n* `tunnel`: This part of the route passes through a tunnel.\n* `bridge`: This part of the route crosses a bridge.\n* `ramp`: This part of the route is a ramp, typically connecting to or from highways.\n* `motorway`: This part of the route is a controlled access road, typically a highway with motorway signage.\n* `roundabout`: This part of the route includes a roundabout.\n* `underConstruction`: This part of the route is currently under construction.\n* `dividedRoad`: This part of the route uses a road with a physical or legal divider in the middle, separating opposing traffic flows.\n* `privateRoad`: This part of the route uses a privately owned road.\n* `controlledAccessHighway`: This part of the route is either a controlled access road, limited access road, or both.\n* `builtUpArea`: This part of the route most likely passes through a built-up area.\n\nIt is possible that new street attributes may be supported in the future. When encountering unknown street attributes, e.g., in the software parser, it is recommended to ignore them.\n","type":"array","items":{"$ref":"#/components/schemas/StreetAttributes"}},"walkAttributes":{"description":"WalkAttributes 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 traversed if origin, destination or any via waypoint is located there.\n* `tollRoad`: This part of the route is restricted with a fee (or toll).\n\nIt is possible that new attributes may be supported in the future. When encountering unknown attributes, e.g., in the software parser, it is recommended to ignore them.\n","type":"array","items":{"$ref":"#/components/schemas/WalkAttributes"}},"carAttributes":{"description":"Car-specific `AccessAttributes`.\n\n`AccessAttributes` is applied to a span of a route section and describe access flags specific to cars. The following flags can be assigned:\n* `open`: This part of the route is open and accessible to cars.\n* `noThrough`: This part of the route can only be traversed by cars if the origin, destination, or any via waypoint is located there. It is not a through-route for cars.\n* `tollRoad`: This part of the route is a toll road, which means access is restricted for cars and requires the payment of a fee or toll.\n\nIt is possible that new access attributes may be supported in the future. When encountering unknown access attributes, e.g., in the software parser, it is recommended to ignore them.\n","type":"array","items":{"$ref":"#/components/schemas/AccessAttributes"}},"truckAttributes":{"description":"Truck-specific `AccessAttributes`.\n\n`AccessAttributes` is applied to a span of a route section and describe access flags specific to trucks. These flags indicate the accessibility and restrictions for trucks along the route. The following flags can be assigned:\n* `open`: This part of the route is open and accessible to trucks.\n* `noThrough`: That this part of the route can only be traversed by trucks if the origin, destination, or any via waypoint is located there. It is not a through-route for trucks.\n* `tollRoad`: This part of the route is a toll road, which means access is restricted for trucks and requires the payment of a fee or toll.\n\nIt is possible that new access attributes may be supported in the future. When encountering unknown access attributes, e.g., in the software parser, it is recommended to ignore them.\n","type":"array","items":{"$ref":"#/components/schemas/AccessAttributes"}},"scooterAttributes":{"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\nIt is possible that new access attributes may be supported in the future. When encountering unknown access attributes, e.g., in the software parser, it is recommended to ignore them.\n","type":"array","items":{"$ref":"#/components/schemas/AccessAttributes"}},"names":{"description":"Designated name for the span (e.g. a street name or a transport name)","type":"array","items":{"$ref":"#/components/schemas/LocalizedString"}},"routeNumbers":{"description":"Designated route name or number of the span (e.g. 'M25')","type":"array","items":{"$ref":"#/components/schemas/LocalizedRouteNumber"}},"countryCode":{"$ref":"#/components/schemas/CountryCode"},"stateCode":{"$ref":"#/components/schemas/StateCode"},"functionalClass":{"$ref":"#/components/schemas/FunctionalClass"},"speedLimit":{"description":"**NOTE:** Attribute speedLimit is deprecated. Use maxSpeed instead.\n","allOf":[{"$ref":"#/components/schemas/Speed"}]},"maxSpeed":{"$ref":"#/components/schemas/MaxSpeed"},"dynamicSpeedInfo":{"$ref":"#/components/schemas/DynamicSpeedInfo"},"segmentId":{"description":"**NOTE:** Attribute segmentId is deprecated. Use segmentRef instead.\n\nThe directed topology segment id including prefix (e.g '+here:cm:segment:').\n\nThe id consists of two parts.\n* The direction ('+' or '-')\n* followed by the topology segment id (a unique identifier within the HERE platform catalogs).\n\nThe direction specifies whether the route is using the segment in its canonical direction ('+' aka traveling along the geometry's direction), or against it ('-' aka traveling against the geometry's direction).\n","type":"string","deprecated":true},"segmentRef":{"$ref":"#/components/schemas/SegmentRef"},"incidents":{"description":"A list of indices into the incident array of the parent section.\nReferences all incidents that apply to the span.\nThis requires `incidents` to be specified as part of the `return` parameter.\n","type":"array","items":{"type":"integer"}},"gate":{"description":"Indication that a gate is present at the end of this span.","allOf":[{"$ref":"#/components/schemas/Gate"}]},"railwayCrossing":{"description":"Indication that a railway crossing is present at the end of this span.","allOf":[{"$ref":"#/components/schemas/RailwayCrossing"}]},"notices":{"description":"A list of indexes into the notices array of the parent section.\nReferences all notices that apply to the span.\n\nDepending on the notice type the notice might apply to the whole span, or only at the end of the span. Notices that only apply at the end of the span are:\n\n| Code | Description |\n| --------- | ------- |\n| violatedTurnRestriction | A restricted turn is performed at the end of the span |\n| violatedAvoidDifficultTurns | A difficult turn is performed at the end of the span |\n| violatedAvoidUTurns | A U-turn is performed at the end of the span |\n| violatedEmergencyGate | An emergency gate is crossed at the end of the span |\n\n**Note:** `difficultTurns` avoidance feature is deprecated and the corresponding notice will not be available in the future.\n","type":"array","items":{"type":"integer"}},"baseDuration":{"description":"Duration of this span (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"}]},"typicalDuration":{"description":"Duration of this span (in seconds) under typical traffic conditions.\n\nFor pedestrian mode, the reported time is currently equal to that in `duration`.\n","allOf":[{"$ref":"#/components/schemas/Duration"}]}}},"RouteResponseNotice":{"example":{"$ref":"#/components/examples/routeResponseNoticeExample"},"type":"object","description":"A notice contains important notifications.","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` `noReachableChargingStationsFound` `violatedTransportModeInRouteHandleDecoding` `unknownError` `routeLengthLimitExceeded` `avoidSegmentsInvalidId` `avoidZonesInvalidId` `avoidTruckRoadTypesInvalidId` `returnToRoute` `importFailed` `importSplitRoute` `brandDoesNotExist` `unknownParameter` `mainLanguageNotFound` `avoidOptionsWithMakeReachableLimitation` `currentWeightChangeNoCurrentWeight` `currentWeightChangeNoGrossWeight` `...` \nCurrently known codes (non-exhaustive: this list could 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| noReachableChargingStationsFound | Initial charge is not enough to reach any known charging stations | 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| routeLengthLimitExceeded | Distance between waypoints is too large for current options | critical |\n| avoidSegmentsInvalidId | The provided segment ID was not found | info |\n| avoidZonesInvalidId | The provided zone ID was not found | info |\n| avoidTruckRoadTypesInvalidId | The provided truck road type id was not found | info |\n| returnToRoute | Applicable only to requests with route handle provided. Current route position was not on the original route. New route was calculated from the current position to the destination. Old route may have been reused. | info |\n| importFailed | No route section was found for imported waypoints | critical |\n| importSplitRoute | Not all trace points were matched | info |\n| brandDoesNotExist | Preferred charging station brand does not exist | info |\n| unknownParameter | The provided parameter is unknown | info |\n| mainLanguageNotFound | The first language in the list of preferred languages is not supported. | info |\n| avoidOptionsWithMakeReachableLimitation | Avoiding toll or controlledAccessHighway with makeReachable is supported only for trucks up to 7.5 tons. | critical |\n| currentWeightChangeNoCurrentWeight | Route handle contains `currentWeightChange` but missing vehicle[currentWeight]. `currentWeight` will not be evaluated. | info |\n| currentWeightChangeNoGrossWeight | Route handle contains `currentWeightChange` but missing vehicle[grossWeight]. Vehicle restrictions based on gross weight will not be evaluated. | info |\n","example":"noRouteFound","x-extensible-enum":["noRouteFound","failedRouteHandleCreation","cancelled","routeCalculationFailed","couldNotMatchOrigin","couldNotMatchDestination","noReachableChargingStationsFound","violatedTransportModeInRouteHandleDecoding","unknownError","routeLengthLimitExceeded","avoidSegmentsInvalidId","avoidZonesInvalidId","avoidTruckRoadTypesInvalidId","returnToRoute","importFailed","importSplitRoute","brandDoesNotExist","unknownParameter","mainLanguageNotFound","avoidOptionsWithMakeReachableLimitation","currentWeightChangeNoCurrentWeight","currentWeightChangeNoGrossWeight"]},"severity":{"$ref":"#/components/schemas/NoticeSeverity"},"details":{"type":"array","description":"Additional details about the notice","items":{"$ref":"#/components/schemas/RouteResponseNoticeDetail"}}},"required":["code"]},"SignpostLabel":{"description":"Label on a signpost.\n","anyOf":[{"$ref":"#/components/schemas/SignpostLabelText"},{"$ref":"#/components/schemas/SignpostLabelRouteNumber"}]},"TimeRestrictedPrice":{"type":"object","properties":{"type":{"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","type":"string"},"estimated":{"description":"Attribute value is `true` if the fare price is estimated, `false` if it is an exact value.","type":"boolean","default":false},"currency":{"description":"Local currency of the price compliant to ISO 4217","type":"string"},"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":{"description":"The price value","type":"number"},"days":{"description":"This price applies only for the selected days","type":"array","items":{"$ref":"#/components/schemas/TimeRestrictedWeekdays"},"example":["sa","su"]},"minDuration":{"description":"The price applies if the duration is more or equal to `minDuration`","allOf":[{"$ref":"#/components/schemas/Duration"}],"example":1801},"maxDuration":{"description":"The price applies if the duration is less or equal to `maxDuration`","allOf":[{"$ref":"#/components/schemas/Duration"}],"example":3600},"fromTime":{"description":"The price applies from this time of the day","allOf":[{"$ref":"#/components/schemas/PartialTime"}]},"toTime":{"description":"The price applies until this time of the day","allOf":[{"$ref":"#/components/schemas/PartialTime"}]}},"required":["type","currency","value"]},"TransitDeparturePlace":{"description":"Departure/arrival location","oneOf":[{"$ref":"#/components/schemas/Place"},{"$ref":"#/components/schemas/StationPlace"}],"discriminator":{"propertyName":"type","mapping":{"place":"#/components/schemas/Place","station":"#/components/schemas/StationPlace"}}},"TransitPostAction":{"oneOf":[{"$ref":"#/components/schemas/DeboardAction"}],"discriminator":{"propertyName":"action","mapping":{"deboard":"#/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"}]},"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/WaitAction"}},"oneOf":[{"$ref":"#/components/schemas/ChargingSetupAction"},{"$ref":"#/components/schemas/ChargingAction"},{"$ref":"#/components/schemas/WaitAction"}]},"VehicleRestriction":{"description":"Provides details about the violated restriction and the violated restriction\nconditions that were evaluated against parameter values set in the routing\nrequest (such as vehicle properties).\n\nThe restriction is violated only if all of the conditions present are met.\n","type":"object","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","enum":["restriction"]},"forbiddenHazardousGoods":{"description":"Hazardous goods restrictions applied during the trip.\n\nThis condition is met when the vehicle's shippedHazardousGoods\ncontains any of the items in the specified array.\n\nThis property can either be \"any\" or a list of all forbidden hazardous goods.\n","allOf":[{"$ref":"#/components/schemas/ForbiddenHazardousGoods"}]},"maxWeight":{"allOf":[{"$ref":"#/components/schemas/VehicleRestrictionMaxWeight"}]},"maxGrossWeight":{"description":"Contains the maximum permitted weight, specified in kilograms.\nThis condition is met when the vehicle's weight exceeds the specified value.\n\n**NOTE:** This attribute is deprecated, use `maxWeight` instead. It is redundant and is present because of backward compatibility reasons.\n","type":"integer","format":"int32","minimum":0,"deprecated":true},"maxWeightPerAxle":{"description":"Contains the maximum permitted weight per axle, specified in kilograms.\n\nThis condition is met when the vehicle's `weightPerAxle` exceeds the specified value.\n","type":"integer","format":"int32","minimum":0},"maxAxleGroupWeight":{"description":"Contains the maximum permitted weight for an axle-group.\n\nThis condition is triggered when the vehicle's `weightPerAxleGroup` exceeds this value.\n","allOf":[{"$ref":"#/components/schemas/AxleGroupWeight"}]},"maxHeight":{"description":"Contains the maximum permitted height, specified in centimeters.\n\nThis condition is met when the vehicle's `height` exceeds the specified value.\n","type":"integer","format":"int32","minimum":0},"maxWidth":{"description":"Contains the maximum permitted width, specified in centimeters.\n\nThis condition is met when the vehicle's `width` exceeds the specified value.\n","type":"integer","format":"int32","minimum":0},"maxLength":{"description":"Contains the maximum permitted length, specified in centimeters.\n\nThis condition is met when the vehicle's `length` exceeds the specified value.\n","type":"integer","format":"int32","minimum":0},"maxTiresCount":{"description":"Contains the maximum number of permitted tires.\n\nThis condition is met when the vehicle's `tiresCount` exceeds the specified value.\n","type":"integer","format":"int32","minimum":0},"axleCount":{"description":"Constrains the restriction to trucks with the number of axles within the specified range.\n\nThis condition is met when the vehicle's `axleCount` is within the specified range.\n","allOf":[{"$ref":"#/components/schemas/TruckAxleCountRange"}]},"tunnelCategory":{"description":"Specifies the tunnel category used to restrict the 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":{"description":"Indicates that the restriction depends on time.\n","type":"boolean"},"truckType":{"description":"Constrains the restriction to a specific type of vehicle.\n\nThis condition is met if the `vehicle[type]` request parameter matches the specified value.\n","deprecated":true,"allOf":[{"$ref":"#/components/schemas/TruckType"}]},"vehicleType":{"description":"Constrains the restriction to a specific type of vehicle.\n\nThis condition is met if the `vehicle[type]` request parameter matches this value.\n","allOf":[{"$ref":"#/components/schemas/VehicleType"}]},"trailerCount":{"description":"Constrains the restriction to trucks with the number of axles within the specified range.\n\nThis condition is met when the vehicle's `trailerCount` is within the specified range.\n","allOf":[{"$ref":"#/components/schemas/TrailerCountRange"}]},"maxEngineSizeCC":{"description":"Contains the maximum permitted size of the engine, specified in cubic centimeters.\n\nThis condition is met when the vehicle's `engineSizeCC` exceeds the specified value.\n","type":"integer","format":"int32","minimum":0},"minEngineSizeCC":{"description":"Contains the minimum permitted size of the engine, specified in cubic centimeters.\n\nThis condition is met when the vehicle's `engineSizeCC' is less than the specified value.\n","type":"integer","format":"int32","minimum":0},"maxOccupancy":{"description":"Contains the maximum permitted occupancy.\n\nThis condition is met when the vehicle's `occupancy` exceeds the specified value.\n","type":"integer","format":"int32","minimum":1},"minOccupancy":{"description":"Contains the minimum permitted occupancy.\n\nThis condition is met when the vehicle's `occupancy` is less than the specified value.\n","type":"integer","format":"int32","minimum":1},"restrictedTimes":{"$ref":"#/components/schemas/TimeDomain"},"maxKpraLength":{"description":"Contains max permitted kingpin to rear axle length, in centimeters.\n\nThis condition is met when the vehicle's `kpraLength` exceeds this value.\n","type":"integer","format":"int32","minimum":0},"maxTrailerLength":{"description":"Contains the maximum permitted trailer length, specified in centimeters.\n\nThis condition is met when the vehicle's `trailerLength` exceeds the specified value.\n","type":"integer","format":"int32","minimum":0},"maxPayloadCapacity":{"description":"Contains the maximum allowed payload capacity, specified in kilograms.\n\nThis condition is met when the vehicle's `payloadCapacity` exceeds the specified value.\n","type":"integer","format":"int32","minimum":0},"unconditional":{"description":"Restriction applies unconditionally.","type":"boolean","default":false}},"required":["type"],"example":{"$ref":"#/components/examples/restrictionExample"}},"VehicleSpan":{"type":"object","description":"Span attached to a `Section` that describes the vehicle content.\n","properties":{"offset":{"description":"Offset of a coordinate in the section's polyline.\n","type":"integer","format":"int32","minimum":0},"length":{"description":"Length of the span.\n","allOf":[{"$ref":"#/components/schemas/Distance"}]},"duration":{"description":"Duration of the span.","allOf":[{"$ref":"#/components/schemas/Duration"}]},"streetAttributes":{"description":"`StreetAttributes` is applied to a span of a route section and describes attribute flags of a street. The following flags can be assigned:\n* `rightDrivingSide`: Vehicles must drive on the right-hand side of the road in this part of the route.\n* `dirtRoad`: This part of the route has an unpaved surface, such as a gravel or dirt road.\n* `tunnel`: This part of the route passes through a tunnel.\n* `bridge`: This part of the route crosses a bridge.\n* `ramp`: This part of the route is a ramp, typically connecting to or from highways.\n* `motorway`: This part of the route is a controlled access road, typically a highway with motorway signage.\n* `roundabout`: This part of the route includes a roundabout.\n* `underConstruction`: This part of the route is currently under construction.\n* `dividedRoad`: This part of the route uses a road with a physical or legal divider in the middle, separating opposing traffic flows.\n* `privateRoad`: This part of the route uses a privately owned road.\n* `controlledAccessHighway`: This part of the route is either a controlled access road, limited access road, or both.\n* `builtUpArea`: This part of the route most likely passes through a built-up area.\n\nIt is possible that new street attributes may be supported in the future. When encountering unknown street attributes, e.g., in the software parser, it is recommended to ignore them.\n","type":"array","items":{"$ref":"#/components/schemas/StreetAttributes"}},"walkAttributes":{"description":"WalkAttributes 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 traversed if origin, destination or any via waypoint is located there.\n* `tollRoad`: This part of the route is restricted with a fee (or toll).\n\nIt is possible that new attributes may be supported in the future. When encountering unknown attributes, e.g., in the software parser, it is recommended to ignore them.\n","type":"array","items":{"$ref":"#/components/schemas/WalkAttributes"}},"carAttributes":{"description":"Car-specific `AccessAttributes`.\n\n`AccessAttributes` is applied to a span of a route section and describe access flags specific to cars. The following flags can be assigned:\n* `open`: This part of the route is open and accessible to cars.\n* `noThrough`: This part of the route can only be traversed by cars if the origin, destination, or any via waypoint is located there. It is not a through-route for cars.\n* `tollRoad`: This part of the route is a toll road, which means access is restricted for cars and requires the payment of a fee or toll.\n\nIt is possible that new access attributes may be supported in the future. When encountering unknown access attributes, e.g., in the software parser, it is recommended to ignore them.\n","type":"array","items":{"$ref":"#/components/schemas/AccessAttributes"}},"truckAttributes":{"description":"Truck-specific `AccessAttributes`.\n\n`AccessAttributes` is applied to a span of a route section and describe access flags specific to trucks. These flags indicate the accessibility and restrictions for trucks along the route. The following flags can be assigned:\n* `open`: This part of the route is open and accessible to trucks.\n* `noThrough`: That this part of the route can only be traversed by trucks if the origin, destination, or any via waypoint is located there. It is not a through-route for trucks.\n* `tollRoad`: This part of the route is a toll road, which means access is restricted for trucks and requires the payment of a fee or toll.\n\nIt is possible that new access attributes may be supported in the future. When encountering unknown access attributes, e.g., in the software parser, it is recommended to ignore them.\n","type":"array","items":{"$ref":"#/components/schemas/AccessAttributes"}},"scooterAttributes":{"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\nIt is possible that new access attributes may be supported in the future. When encountering unknown access attributes, e.g., in the software parser, it is recommended to ignore them.\n","type":"array","items":{"$ref":"#/components/schemas/AccessAttributes"}},"names":{"description":"Designated name for the span (e.g. a street name or a transport name)","type":"array","items":{"$ref":"#/components/schemas/LocalizedString"}},"routeNumbers":{"description":"Designated route name or number of the span (e.g. 'M25')","type":"array","items":{"$ref":"#/components/schemas/LocalizedRouteNumber"}},"countryCode":{"$ref":"#/components/schemas/CountryCode"},"stateCode":{"$ref":"#/components/schemas/StateCode"},"functionalClass":{"$ref":"#/components/schemas/FunctionalClass"},"speedLimit":{"description":"**NOTE:** Attribute speedLimit is deprecated. Use maxSpeed instead.\n","allOf":[{"$ref":"#/components/schemas/Speed"}]},"maxSpeed":{"$ref":"#/components/schemas/MaxSpeed"},"dynamicSpeedInfo":{"$ref":"#/components/schemas/DynamicSpeedInfo"},"segmentId":{"description":"**NOTE:** Attribute segmentId is deprecated. Use segmentRef instead.\n\nThe directed topology segment id including prefix (e.g '+here:cm:segment:').\n\nThe id consists of two parts.\n* The direction ('+' or '-')\n* followed by the topology segment id (a unique identifier within the HERE platform catalogs).\n\nThe direction specifies whether the route is using the segment in its canonical direction ('+' aka traveling along the geometry's direction), or against it ('-' aka traveling against the geometry's direction).\n","type":"string","deprecated":true},"segmentRef":{"$ref":"#/components/schemas/SegmentRef"},"incidents":{"description":"A list of indices into the incident array of the parent section.\nReferences all incidents that apply to the span.\nThis requires `incidents` to be specified as part of the `return` parameter.\n","type":"array","items":{"type":"integer"}},"gate":{"description":"Indication that a gate is present at the end of this span.","allOf":[{"$ref":"#/components/schemas/Gate"}]},"railwayCrossing":{"description":"Indication that a railway crossing is present at the end of this span.","allOf":[{"$ref":"#/components/schemas/RailwayCrossing"}]},"notices":{"description":"A list of indexes into the notices array of the parent section.\nReferences all notices that apply to the span.\n\nDepending on the notice type the notice might apply to the whole span, or only at the end of the span. Notices that only apply at the end of the span are:\n\n| Code | Description |\n| --------- | ------- |\n| violatedTurnRestriction | A restricted turn is performed at the end of the span |\n| violatedAvoidDifficultTurns | A difficult turn is performed at the end of the span |\n| violatedAvoidUTurns | A U-turn is performed at the end of the span |\n| violatedEmergencyGate | An emergency gate is crossed at the end of the span |\n\n**Note:** `difficultTurns` avoidance feature is deprecated and the corresponding notice will not be available in the future.\n","type":"array","items":{"type":"integer"}},"tollSystems":{"description":"The toll systems applicable to specific spans are described using an array of reference indexes. These indexes correspond to the `tollSystems` array in the enclosing section. Please note that toll information is not static and can vary based on factors such as transport-mode, time-of-day, etc. Therefore, the tolls applicable to a span may change in similar requests.\n","type":"array","items":{"type":"integer"}},"consumption":{"description":"The estimated net energy or fuel consumption along a span of the route is provided based on the `consumptionType` of the section. The value represents either net energy consumption or fuel consumption. Here are the units used for different vehicle types:\n* For electric vehicles (EVs): The energy consumption is measured in kilowatt-hours (kWh). This indicates the amount of energy consumed by the EV while traversing the specific span.\n* For fuel-based vehicles: Depending on the fuel type, the fuel consumption is measured in liters (for diesel, petrol vehicles, and vehicles using liquefied petroleum gas (LPG)), and in kilograms (for vehicles using compressed natural gas (CNG)).\n","allOf":[{"$ref":"#/components/schemas/Consumption"}]},"baseDuration":{"description":"The duration of this span, specified in seconds, without taking time-aware information into account.\n\nDynamic traffic information is not considered. The duration is calculated using average free-flow speeds based on historical traffic, without taking into account the current traffic conditions.\n\nThe actual duration of the route section may be lower than `baseDuration` in some cases, e.g. if `trafficSpeed` is greater than `baseSpeed`.\n","allOf":[{"$ref":"#/components/schemas/Duration"}]},"typicalDuration":{"description":"The duration of this span, specified in seconds, under typical traffic conditions.\n\nDynamic traffic information is not considered. Instead, the duration is calculated using speeds that are typical for the given time of day/day of week, based on historical traffic data.\n\n**Note:** Will be the same as `baseDuration` if `traffic[mode]=disabled` is specified.\n","allOf":[{"$ref":"#/components/schemas/Duration"}]},"intersectionIncidents":{"description":"A list of indexes in the incident array of the parent section.\nReferences all incidents that block movement through the intersection at the end of this span.\nThis requires `incidents` to be specified in `return` and `spans` parameters.\n","type":"array","items":{"type":"integer"}},"routingZones":{"description":"A list of indexes into the routing zone array of the parent section.\nReferences all applicable routing zones to the span.\n","type":"array","items":{"type":"integer"}},"truckRoadTypes":{"description":"A list of indexes into the truck road types array of the parent section. References all applicable truck road types to the span.","type":"array","items":{"type":"integer"}},"noThroughRestrictions":{"description":"A list of indexes into the `noThroughRestrictions` array of the parent section.\nReferences all `noThroughRestrictions` that apply to the span.\n","type":"array","items":{"type":"integer"}},"hovAttributes":{"description":"`hovAttributes` is applied to a span of a route section and indicates the presence of usable HOV lanes.\n","allOf":[{"$ref":"#/components/schemas/HovAttributes"}]},"permittedNetworks":{"$ref":"#/components/schemas/PermittedNetworks"}}},"BoundingBoxAreaWithExceptions":{"description":"A bounding box defined by two longitudes and two latitudes.\nCan be expanded to include excepted areas that are excluded from the current bounding box area.\n","type":"object","required":["type","north","south","west","east"],"properties":{"type":{"type":"string","example":"boundingBox"},"north":{"description":"Latitude in WGS-84 degrees of the northern boundary of the box.","type":"number","minimum":-90,"maximum":90,"example":30},"south":{"description":"Latitude in WGS-84 degrees of the southern boundary of the box.","type":"number","minimum":-90,"maximum":90,"example":30},"east":{"description":"Longitude in WGS-84 degrees of the eastern boundary of the box","type":"number","minimum":-180,"maximum":180,"example":30},"west":{"description":"Longitude in WGS-84 degrees of the western boundary of the box.","type":"number","minimum":-180,"maximum":180,"example":30},"exceptions":{"type":"array","description":"Optional list of areas to exclude from avoidance.","items":{"$ref":"#/components/schemas/Area"},"minItems":0}}},"CorridorAreaWithExceptions":{"description":"A polyline with a specified radius in meters that defines an area.\nCan be expanded to include excepted areas that are excluded from the current corridor area.\n","type":"object","required":["type","polyline","radius"],"properties":{"type":{"type":"string","example":"corridor"},"polyline":{"type":"array","description":"List of coordinates defining polyline.","items":{"$ref":"#/components/schemas/Coordinate"},"minItems":2,"maxItems":100},"radius":{"type":"integer","description":"The width in meters of the corridor determines the outline of the polygon.","minimum":1,"maximum":1000},"exceptions":{"type":"array","description":"Optional list of areas to exclude from avoidance.","items":{"$ref":"#/components/schemas/Area"},"minItems":0}}},"EV":{"type":"object","description":"EV properties to be used for calculating consumption.\n\nThere are two consumption models (`empirical`, `physical`). Set the `consumptionModel` parameter to choose which model to use.\n\nRequired `empirical` model properties:\n* `freeFlowSpeedTable`\n\nRequired `physical` model properties:\n* `driveEfficiency`\n* `recuperationEfficiency`\n\nWhen using the physical model, certain properties of the `vehicle` parameter are also required (see documentation for the `vehicle` parameter for more details):\n* `rollingResistanceCoefficient`\n* `airDragCoefficient`\n* `currentWeight`\n* `frontalArea` or combination of `width` and `height`\n\nThe following `ev` properties are additionally required in order to calculate State-of-Charge along the route:\n* `initialCharge`\n* `maxCharge`\n\nRoute reachability based on State-of-Charge will be evaluated for the following constraints, if additionally provided,\n* `minChargeAtDestination`\n* `minChargeAtFirstChargingStation`\n* `minChargeAtChargingStation`\n\nThe following properties are additionally required in order to calculate charging at charging station waypoints (see documentation for `via` parameter)\n* `chargingCurve`\n\n**Notes**:\n* Hybrid vehicles (EV + Other fuel types) are not supported. Consumption properties are not supported for combination of `ev` and `fuel` vehicles.\n* EV parameters are not supported in combination with pedestrian, bicycle and network restricted truck `transportMode`.\n\nThe following properties are additionally required for the router to automatically enhance the route with charging stops\n* `makeReachable` set to `true`\n* `chargingCurve`\n* `connectorTypes`\n* `maxChargeAfterChargingStation`\n","oneOf":[{"$ref":"#/components/schemas/EVEmpiricalModel"},{"$ref":"#/components/schemas/EVPhysicalModel"}],"properties":{"makeReachable":{"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* `routingMode=fast`\n* `transportMode=car` or `transportMode=truck` (Beta)\n\nSupport for this feature with `transportMode=truck` is currently in beta release, with the following limitations:\n* `avoid[features]=controlledAccessHighway` and `avoid[features]=tollRoad` in combination with `transportMode=truck` are supported only for `vehicle[grossWeight]` up to 7500 kg.\n* Trucks above 4200 kg are limited to following countries:\n - Germany\n - Netherlands\n - Belgium\n - Luxembourg\n - Denmark\n - Sweden\n - Switzerland\n - Austria\n - Liechtenstein\n - Norway\n\n This is mainly because the coverage of charging station data for trucks is limited outside of these countries.\n* For trucks up to 7500 kg the coverage of charging stations can be improved by including car charging stations by specifying `ev[allowCarChargingStations]=true`. This will also enable routing in countries other than the ones listed above.\n* Quality of the resulting routes and performance of the calculation is not guaranteed.\n\n**Note**:\n* When setting avoid[areas] option, the route calculation may fail if route has to take significant detour to avoid them.\n","type":"boolean"},"preferredBrands":{"description":"Comma-separated list of charging station brand IDs. If `makeReachable` is set to `true`, then charging stations from the specified brands\nwill be preferred as potential charging stops, even if this makes the total route duration (travel time plus charging time) longer (up to 15 minutes per charging stop).\n\n**Note**:\n* This parameter is deprecated. Use `preferredChargePointOperators` instead.\n","type":"string","deprecated":true},"excludeChargingStations":{"description":"Comma-separated list of charging station IDs. ID values can be found in the Routing API response. See `ChargingStationPlace.id`.\nThese charging stations are to be excluded during EV route calculations, even if no other charging stations are reachable.\nAdding this parameter might result in `noReachableChargingStationsFound` response.\nMore information about charging stations can be found in the [EV routing](https://docs.here.com/routing/docs/routing-v8-ev-routing) section of the Developer Guide.\n\n**Note**:\n* Maximum number of charging station IDs supported in one request is 10.\n","type":"string","example":"276u33dc1rxhv-aGVyZS1ldjplY29tb3ZlbWVudDo5MTk5ODEzNjE,276u33dbk5e2h-aGVyZS1ldjplY29tb3ZlbWVudDo5NDMwNzkyMzA"},"excludeChargePointOperators":{"description":"Comma-separated list of charge-point-operator IDs. ID values can be found in the Routing API response. The charging stations with these charge-point-operators IDs\nwill be excluded during EV route calculation, even if no other charging stations are reachable.\nAdding this parameter might result in `noReachableChargingStationsFound` response.\nDetails of Charge Point Operators are available from the [HERE EV Charge Points API v3](https://docs.here.com/ev-products/docs/readme-guide) service.\nThis [tutorial](https://docs.here.com/ev-products/docs/tutorial-metadata) has details on retrieving the list by country.\n\n**Note**:\n* Maximum number of IDs that can be excluded is limited to 10.\n","type":"string","example":"1f608648-cca5-11ed-bb1e-42010aa40002,1f90fdf0-cca5-11ed-be23-42010aa40002"},"preferredChargePointOperators":{"description":"Comma-separated list of charge-point-operator IDs. If `makeReachable` is set to `true`, then charging station\nwith one of provided charge-point-operators will be preferred as potential charging stop, even if this makes the total route\nduration (travel time plus charging time) longer (up to 15 minutes per charging stop).\nDetails of Charge Point Operators are available from the [HERE EV Charge Points API v3](https://www.here.com/docs/category/ev-charge-points-api-v3) service.\nThis [tutorial](https://docs.here.com/ev-products/docs/tutorial-metadata) has details on retrieving the list by country.\n\n**Note**:\n* Maximum number of IDs that can be preferred is limited to 10.\n","type":"string"},"eMobilityServiceProviderPreferences":{"description":"Specifies a comma-separated list of E-Mobility Service Providers with their associated preference levels.\nThese settings are used to prefer charging stations that support the specified E-Mobility Service Provider(s).\nSingle E-Mobility Service Provider preference is comprised of semicolon-separated E-Mobility Service Provider ID and\nassociated preference level. Details of eMobility Service Providers are available from the [HERE EV Charge Points API v3](https://www.here.com/docs/category/ev-charge-points-api-v3) service.\nThis [tutorial](https://docs.here.com/ev-products/docs/tutorial-metadata) has details on retrieving the list by country.\n\n## Format: `{emobility-service-provider-id};preference={preference-level}[,{emobility-service-provider-id};preference={preference-level}]...`\n\n## Supported E-Mobility Service Provider IDs\n\n* A valid E-Mobility Service Provider ID\n* `default`: special value to be used in place of an id, to model default behavior when a station doesn't support any of the specified E-Mobility Service Providers.\n The preference level passed with `default` is applied to such stations. This value must be lowest of all preferences.\n If a `default` preference level is not specified, the value `exclude` is applied to the stations under this category.\n\n\n## Supported preference levels\n\n*`high`: Stations that support E-Mobility Service Providers with `high` preference level are preferred over all other stations. At least one Provider must be specified with this level.\n* `medium`: Stations supporting E-Mobility Service Providers with `medium` preference level are considered only in case the vehicle cannot reach stations supporting Providers with `high` level.\n* `low`: Stations supporting only E-Mobility Service Providers with `low` preference level are preferred the least and such stations are considered only in case the vehicle cannot reach stations that support Providers with `high` or `medium` level.\n* `exclude`: Can only be used as the `default` preference level. When `exclude` is the `default`, stations that are not assigned a higher preference are never considered.\n\n**Note**:\n* Maximum number of IDs that can be preferred is limited to 10.\n","type":"string","example":"ev[eMobilityServiceProviderPreferences]=default;preference=low,79c4c474-19a2-11ee-880e-42010aa40002;preference=high,2d6754b0-cca5-11ed-ade1-42010aa40002;preference=medium"},"allowCarChargingStations":{"description":"When set to `true`, and when `ev[makeReachable]=true` and `transportMode=truck`, charging at stations that are open for cars is allowed, even when the station is not explicitly open for trucks. This feature can be used, for example, for lighter trucks, like vans, which are small enough to access car chargers.\nThis option is applicable only if `vehicle[grossWeight]` is set to less than 7500 kg. If `vehicle[grossWeight]` is not provided, `vehicle[currentWeight]` is considered instead. If the applicable weight exceeds 7500 kg, an error is returned.\n","type":"boolean","default":false}}},"EVRouteHandle":{"type":"object","description":"EV properties to be used for calculating consumption.\n\nThere are two consumption models (`empirical`, `physical`). Set the `consumptionModel` parameter to choose which model to use.\n\nRequired `empirical` model properties:\n* `freeFlowSpeedTable`\n\nRequired `physical` model properties:\n* `driveEfficiency`\n* `recuperationEfficiency`\n\nWhen using the physical model, certain properties of the `vehicle` parameter are also required (see documentation for the `vehicle` parameter for more details):\n* `rollingResistanceCoefficient`\n* `airDragCoefficient`\n* `currentWeight`\n* `frontalArea` or combination of `width` and `height`\n\nThe following `ev` properties are additionally required in order to calculate State-of-Charge along the route:\n* `initialCharge`\n* `maxCharge`\n\nRoute reachability based on State-of-Charge will be evaluated for the following constraints, if additionally provided,\n* `minChargeAtDestination`\n* `minChargeAtFirstChargingStation`\n* `minChargeAtChargingStation`\n\nThe following properties are additionally required in order to calculate charging at charging station waypoints (see documentation for `via` parameter)\n* `chargingCurve`\n\n**Notes**:\n* Hybrid vehicles (EV + Other fuel types) are not supported. Consumption properties are not supported for combination of `ev` and `fuel` vehicles.\n* EV parameters are not supported in combination with pedestrian, bicycle and network restricted truck `transportMode`.\n","oneOf":[{"$ref":"#/components/schemas/EVEmpiricalModel"},{"$ref":"#/components/schemas/EVPhysicalModel"}],"properties":{"eMobilityServiceProviderPreferences":{"description":"Specifies a comma-separated list of E-Mobility Service Providers with their associated preference levels.\nThese settings are used to prefer or exclude charging stations supporting specified set of E-Mobility Service Provider(s).\nSingle E-Mobility Service Provider preference is comprised of semicolon-separated E-Mobility Service Provider ID and\nassociated preference level. Details of eMobility Service Providers are available from the [HERE EV Charge Points API v3](https://www.here.com/docs/category/ev-charge-points-api-v3) service.\nThis [tutorial](https://docs.here.com/ev-products/docs/tutorial-metadata) has details on retrieving the list by country.\n\n## Format: `{emobility-service-provider-id;preference=preference-level[,emobility-service-provider-id;preference=preference-level]...}`\n\n## Supported E-Mobility Service Provider IDs\n\n* A valid E-Mobility Service Provider ID\n* `default`: special value to be used in place of id, to model default behavior when a station doesn't support any of the provided E-Mobility Service Providers.\n The preference level passed with `default` is applied to such stations.\n If not specified then preference level `exclude` is applied, which means that stations not supporting any of the provided E-Mobility Service Providers are not considered for charging stop.\n Check example section for the usage.\n\n\n## Supported preference levels\n\n* `high`: specifies that E-Mobility Service Provider ID passed along is preferred the most. Stations supporting\n E-Mobility Service Providers with high preference level are chosen over all other stations.\n* `medium`: Stations supporting E-Mobility Service Providers in this preference setting are taken into consideration only in case the vehicle cannot reach stations supporting\n E-Mobility Service Providers with high preference.\n* `low`: Stations supporting only low preference level E-Mobility Service Providers are preferred the least and such stations\n are chosen only in case the vehicle cannot reach stations that support E-Mobility Service Providers with high or medium preference.\n* `exclude`: stations that only support E-Mobility Service Providers with this preference level are never selected as a charging stop.\n\n**Notes**:\n* Maximum number of E-Mobility Service Providers in preferences is limited to 10\n* In routeHandle request this affects only value of matchingEMobilityServiceProviders in the response. The route is not affected in any way.\n For convenience the format of the parameter is same as in route calculation request.\n","type":"string","example":"ev[eMobilityServiceProviderPreferences]=default;preference=low,79c4c474-19a2-11ee-880e-42010aa40002;preference=high,2d6754b0-cca5-11ed-ade1-42010aa40002;preference=medium"}}},"EncodedCorridorAreaWithExceptions":{"description":"A polygon defined as a [Flexible Polyline](https://github.com/heremaps/flexible-polyline) encoded string\nand with a specified radius that defines an area.\nCan be expanded to include excepted areas that are excluded from the current corridor area.\n","type":"object","required":["type","polyline","radius"],"properties":{"type":{"type":"string","example":"encodedCorridor"},"polyline":{"type":"string","description":"[Flexible Polyline](https://github.com/heremaps/flexible-polyline) that defines a supporting structure for a corridor.\nNotes:\n* Support only 2D polyline (without `elevation` specified).\n* Minimum count of vertices in polyline is 2.\n* Maximum count of vertices in polyline is 100.\n","example":"BFoz5xJ67i1B1B7PzIhaxL7Y"},"radius":{"type":"integer","description":"The width in meters of the corridor determines the outline of the polygon.","minimum":1,"maximum":1000},"exceptions":{"type":"array","description":"Optional list of areas to exclude from avoidance.","items":{"$ref":"#/components/schemas/Area"},"minItems":0}}},"EncodedPolygonAreaWithExceptions":{"description":"A polygon defined as a [Flexible Polyline](https://github.com/heremaps/flexible-polyline) encoded string.\nCan be expanded to include excepted areas that are excluded from the current polygon area.\n","type":"object","required":["type","outer"],"properties":{"type":{"type":"string","example":"encodedPolygon"},"outer":{"type":"string","description":"[Flexible Polyline](https://github.com/heremaps/flexible-polyline) that defines the outline of the polygon.\nNotes:\n* Support only 2D polyline (without `elevation` specified).\n* Minimum count of vertices in polygon is 3.\n* Maximum count of vertices in polygon is 16.\n","example":"BFoz5xJ67i1B1B7PzIhaxL7Y"},"exceptions":{"type":"array","description":"Optional list of areas to exclude from avoidance.","items":{"$ref":"#/components/schemas/Area"},"minItems":0}}},"Fare":{"type":"object","description":"\"`Fare` type contains information about a single fare or ticket needed for this section of the route.\"\n\n**NOTE**: Fares information support will be available soon.\n","properties":{"id":{"description":"Unique Fare id. Used to deduplicate fares that apply to multiple sections","type":"string","example":"carrideco-1753076078174759852-1749341260512683512"},"name":{"description":"Name of a fare","type":"string","example":"Carride Company"},"price":{"$ref":"#/components/schemas/FarePrice"},"convertedPrice":{"$ref":"#/components/schemas/FarePrice"},"reason":{"default":"ride","description":"Extensible enum: `ride` `parking` `toll` `...` \nReason for the cost described in this `Fare` element.\n","type":"string","x-extensible-enum":["ride","parking","toll"]},"paymentMethods":{"description":"Specifies the payment methods for which this fare is valid.\n","type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"},"minItems":1,"uniqueItems":true},"pass":{"$ref":"#/components/schemas/FarePass"},"applicableTimes":{"description":"Specifies the time domain when this fare is valid. If this field is missing, it means the fare is always valid.\n\nFor a detailed description of the Time Domain specification and usage in routing services, please refer to\nthe documentation available in the [Time Domain](https://docs.here.com/routing/docs/routing-v8-time-domain-basics) page.\n","type":"string","allOf":[{"$ref":"#/components/schemas/TimeDomain"}]},"transponders":{"description":"List of transponder systems for which this fare is applicable. Only available for transponder payment method","type":"array","items":{"$ref":"#/components/schemas/TransponderSystem"}}},"required":["id","name","price"]},"ParkingLotPlace":{"type":"object","description":"A parking lot","properties":{"name":{"description":"Location name","type":"string"},"waypoint":{"description":"If present, this place corresponds to the `via` in the request with the same index.\n\nExample:\n\nIf the request contains `via=&via=`\n* the place corresponding to `` in the response will have `waypoint: 0`\n* the place corresponding to `` in the response will have `waypoint: 1`.\n\nNotes:\n* `waypoint` is not present for `origin` and `destination` places. `origin` and `destination` waypoints can be trivially identified in the response as the `departure` of the first section and the `arrival` of the final section, respectively.\n* `waypoint` is not present for any stops that are added automatically by the router.\n","type":"integer","minimum":0},"type":{"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","type":"string","enum":["parkingLot"]},"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"}]},"displayLocation":{"description":"If present, the display position of this location provided in the request or that of the auto-added waypoint. This is different from the originalLocation and location which are generally expected to be on the navigable road network, i.e., on segments. This coordinate, for example, is the location of the POI as shown by the pin on a map.","allOf":[{"$ref":"#/components/schemas/Location"}]},"sideOfStreet":{"description":"Location of the waypoint or destination, relative to the driving direction on the street/road.\n\n**NOTE:** Based on the original waypoint position and `sideOfStreetHint` waypoint property.\n - If `sideOfStreetHint` property is specified, it takes priority in determining the side of street in the response.\n - Nothing is returned in the response in case the side of street is ambiguous (too close to the street),\n or if the position is too far from the street.\n\n* 'left`: The left side of the street in relation to the driving direction of the route.\n* `right`: The right side of the street in relation to the driving direction of the route.\n","type":"string","enum":["left","right"]},"id":{"description":"Identifier of this parking lot","type":"string"},"attributes":{"type":"array","description":"Attributes of a parking lot.","items":{"$ref":"#/components/schemas/ParkingLotPlaceType"}},"rates":{"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","type":"array","items":{"$ref":"#/components/schemas/TimeRestrictedPrice"}}},"required":["type","location"],"example":{"type":"place","location":{"lat":50.339167,"lng":18.93}}},"PolygonAreaWithExceptions":{"description":"A polygon defined as a list of coordinates.\nSelf-intersecting polygons are not supported.\nCan be expanded to include excepted areas that are excluded from the current polygon area.\n","type":"object","required":["type","outer"],"properties":{"type":{"type":"string","example":"polygon"},"outer":{"type":"array","description":"List of coordinates defining the outline of the polygon.","items":{"$ref":"#/components/schemas/Coordinate"},"minItems":3,"maxItems":100},"exceptions":{"type":"array","description":"Optional list of areas to exclude from avoidance.","items":{"$ref":"#/components/schemas/Area"},"minItems":0}}},"SignpostInfo":{"type":"object","description":"Signpost information attached to an offset action.\n","properties":{"labels":{"description":"Part of a signpost representing particular direction or destination.\n","type":"array","items":{"$ref":"#/components/schemas/SignpostLabel"}}},"required":["labels"],"example":{"$ref":"#/components/examples/routeResponseManeuverSignpostInfoExample"}},"TollCountrySummary":{"type":"object","properties":{"countryCode":{"$ref":"#/components/schemas/CountryCode"},"price":{"$ref":"#/components/schemas/FarePrice"}}},"TollSystemSummary":{"type":"object","properties":{"tollSystem":{"description":"Reference index into the `tollSystems` array of the containing section.\n","type":"integer"},"price":{"$ref":"#/components/schemas/FarePrice"}}},"TransitDeparture":{"type":"object","description":"Transit departure","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/TransitDeparturePlace"},"charge":{"description":"Vehicle battery charge, specified in kilowatt-hours (kWh).\n**NOTE:** This is only returned in ferry sections when a vehicle route requests battery consumption.\n","type":"number"}},"required":["place"]},"TransitNoticeDetail":{"description":"Details attached to notices in vehicle section.","oneOf":[{"$ref":"#/components/schemas/VehicleRestriction"},{"$ref":"#/components/schemas/ViolatedTransportMode"}],"discriminator":{"propertyName":"type","mapping":{"restriction":"#/components/schemas/VehicleRestriction","violatedTransportMode":"#/components/schemas/ViolatedTransportMode"}}},"VehicleNoticeDetail":{"description":"Details attached to notices in vehicle section.","oneOf":[{"$ref":"#/components/schemas/VehicleRestriction"},{"$ref":"#/components/schemas/ViolatedTransportMode"},{"$ref":"#/components/schemas/ViolatedTruckRoadType"},{"$ref":"#/components/schemas/ViolatedZoneReference"},{"$ref":"#/components/schemas/ViolatedChargingStationOpeningHours"}],"discriminator":{"propertyName":"type","mapping":{"restriction":"#/components/schemas/VehicleRestriction","violatedTransportMode":"#/components/schemas/ViolatedTransportMode","truckRoadType":"#/components/schemas/ViolatedTruckRoadType","zoneReference":"#/components/schemas/ViolatedZoneReference","violatedOpeningHours":"#/components/schemas/ViolatedChargingStationOpeningHours"}}},"AreaPost":{"oneOf":[{"$ref":"#/components/schemas/BoundingBoxAreaWithExceptions"},{"$ref":"#/components/schemas/PolygonAreaWithExceptions"},{"$ref":"#/components/schemas/EncodedPolygonAreaWithExceptions"},{"$ref":"#/components/schemas/CorridorAreaWithExceptions"},{"$ref":"#/components/schemas/EncodedCorridorAreaWithExceptions"}],"discriminator":{"propertyName":"type","mapping":{"boundingBox":"#/components/schemas/BoundingBoxAreaWithExceptions","polygon":"#/components/schemas/PolygonAreaWithExceptions","encodedPolygon":"#/components/schemas/EncodedPolygonAreaWithExceptions","corridor":"#/components/schemas/CorridorAreaWithExceptions","encodedCorridor":"#/components/schemas/EncodedCorridorAreaWithExceptions"}},"description":"Defines an explicit area to avoid/exclude when calculating the routes.\nArea specified by boundingBoxes or polygons (as encoded polyline or as list of geopoints) or corridor area.\nCan be expanded to include excepted areas that are excluded from the current avoidance.\n\nNotes:\n* Maximum count of avoided and excluded polygons and corridors is 20.\n* Maximum total count of avoided and excluded bounding boxes, polygons, corridors, including exceptions, is 250.\n"},"OffsetAction":{"description":"An action to be performed at or during a specific portion of a section.\n","type":"object","properties":{"action":{"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","type":"string"},"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":{"description":"Description of the action (e.g. Turn left onto Minna St.).","type":"string"},"offset":{"description":"Offset of a coordinate in the section's polyline.","type":"integer","example":0},"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"}]},"signpost":{"description":"Signpost information of the action, provided for turn by turn actions only","allOf":[{"$ref":"#/components/schemas/SignpostInfo"}]}},"required":["action","duration"]},"PedestrianPlace":{"description":"Place used in pedestrian routing","oneOf":[{"$ref":"#/components/schemas/Place"},{"$ref":"#/components/schemas/StationPlace"},{"$ref":"#/components/schemas/AccessPointPlace"},{"$ref":"#/components/schemas/ParkingLotPlace"},{"$ref":"#/components/schemas/ChargingStationPlace"},{"$ref":"#/components/schemas/DockingStationPlace"}],"discriminator":{"propertyName":"type","mapping":{"place":"#/components/schemas/Place","station":"#/components/schemas/StationPlace","accessPoint":"#/components/schemas/AccessPointPlace","parkingLot":"#/components/schemas/ParkingLotPlace","chargingStation":"#/components/schemas/ChargingStationPlace","dockingStation":"#/components/schemas/DockingStationPlace"}}},"TollFare":{"description":"Contains information about a single toll fare needed for this section of the route.\n","type":"object","properties":{"id":{"description":"Unique Fare id. Used to deduplicate fares that apply to multiple sections","type":"string","example":"carrideco-1753076078174759852-1749341260512683512"},"name":{"description":"Name of a toll fare.\n\n**NOTE** This property is deprecated. A toll fare represents one of the various fares linked to the route section\ntoll cost(`TollCost`) and for a toll cost associated with a single toll system the fare name is same as the\ntoll system name. But for a toll cost associated with multiple toll systems this parameter will return the name of\nonly one toll system. To get the names of all the toll systems associated with a toll cost use `TollCost.tollSystems`.\n","type":"string","example":"Carride Company","deprecated":true},"price":{"$ref":"#/components/schemas/FarePrice"},"convertedPrice":{"$ref":"#/components/schemas/FarePrice"},"reason":{"default":"ride","description":"Extensible enum: `ride` `parking` `toll` `...` \nReason for the cost described in this `Fare` element.\n","type":"string","x-extensible-enum":["ride","parking","toll"]},"paymentMethods":{"description":"Specifies the payment methods for which this fare is valid.\n","type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"},"minItems":1,"uniqueItems":true},"pass":{"$ref":"#/components/schemas/FarePass"},"applicableTimes":{"description":"Specifies the time domain when this fare is valid. If this field is missing, it means the fare is always valid.\n\nFor a detailed description of the Time Domain specification and usage in routing services, please refer to\nthe documentation available in the [Time Domain](https://docs.here.com/routing/docs/routing-v8-time-domain-basics) page.\n","type":"string","allOf":[{"$ref":"#/components/schemas/TimeDomain"}]},"transponders":{"description":"List of transponder systems for which this fare is applicable. Only available for transponder payment method","type":"array","items":{"$ref":"#/components/schemas/TransponderSystem"}}},"required":["id","name","price"]},"TollSummary":{"type":"object","description":"The summary of the tolls grouped by criteria (total, per system, per country).\n","properties":{"total":{"description":"Represents the overall sum of toll fees for the entire route or section. It provides the aggregated amount of toll charges without further breakdown.\n","allOf":[{"$ref":"#/components/schemas/FarePrice"}]},"totalBySystem":{"description":"Categorizes toll fees based on the different toll systems applicable along the route or section. Each toll system has its own set of charges and payment rules. The summary provides a breakdown of toll costs for each individual toll system encountered.\n","type":"array","items":{"$ref":"#/components/schemas/TollSystemSummary"}},"totalByCountry":{"description":"Groups toll fees based on the countries traversed during the route or section. It provides a breakdown of toll charges specific to each country.\n","type":"array","items":{"$ref":"#/components/schemas/TollCountrySummary"}}}},"TransitNotice":{"type":"object","description":"A notice contains important notifications.","properties":{"title":{"type":"string","description":"Human-readable notice description.","example":"No schedule"},"code":{"type":"string","description":"Extensible enum: `noSchedule` `noIntermediate` `unwantedMode` `scheduledTimes` `simplePolyline` `violatedAvoidFerry` `violatedAvoidRailFerry` `violatedBlockedRoad` `violatedVehicleRestriction` `seasonalClosure` `currentWeightNegative` `currentWeightExceedsLimit` `travelTimeExceedsDriverWorkHours` `vehicleRestriction` `...` \nCurrently known codes (non-exhaustive: this list could be extended for new situations):\n\n| Code | Description | Severity |\n| --------- | ------- | ------- |\n| noSchedule | A timetable schedule is not available for the transit line in this section, and only the run frequency is available. As a result, departure/arrival times are approximated | info |\n| noIntermediate | Information about intermediate stops is not available for this transit line | info |\n| unwantedMode | This section contains a transport mode that was explicitly disabled. Mode filtering is not available in this area | info |\n| scheduledTimes | The times returned on this section are the scheduled times even though delay information are available | 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| violatedAvoidFerry | Route did not manage to avoid user preference | critical |\n| violatedAvoidRailFerry | Route did not manage to avoid user preference | critical |\n| violatedBlockedRoad | Route uses form of transit that are blocked due to `avoid[areas]` or `avoid[segments]` | critical |\n| violatedVehicleRestriction | Route uses form of transit which is forbidden for the given vehicle profile | critical |\n| seasonalClosure | Route goes through seasonal closure | info |\n| currentWeightNegative | `vehicle[currentWeight]` is negative after applying `currentWeightChange` at a via waypoint. | critical |\n| currentWeightExceedsLimit | `vehicle[currentWeight]` exceeds limit for given `transportMode` | critical |\n| travelTimeExceedsDriverWorkHours | The route travelTime exceeds drive time sequence provided in `driver[schedule]` parameter | critical |\n\n\nThe codes listed below can appear as info notices when the request contains `return=potentialTimeDependentViolations`.\nThe resulting info notices are not violations on the current route but could be violations if the arrival time\nat these restrictions differs from the calculated time.\nFor example, an info notice for a `vehicleRestriction` could indicate that your vehicle is not currently violating any restriction but,\nIf the journey is delayed by an hour, the vehicle would not be allowed on part of the route because there is a time-dependent restriction active at that time.\n\nCodes for potential time-dependent restriction violations are (non-exhaustive: can be extended for new situations):\n\n| Code | Description | Severity |\n| --------- | ------- | ------- |\n| vehicleRestriction | Route potentially uses form of transit which is forbidden for the given vehicle profile | info |\n","example":"noSchedule","x-extensible-enum":["noSchedule","noIntermediate","unwantedMode","scheduledTimes","simplePolyline","violatedAvoidFerry","violatedAvoidRailFerry","violatedBlockedRoad","violatedVehicleRestriction","seasonalClosure","currentWeightNegative","currentWeightExceedsLimit","travelTimeExceedsDriverWorkHours","vehicleRestriction"]},"severity":{"$ref":"#/components/schemas/NoticeSeverity"},"details":{"type":"array","description":"Additional details about the notice","items":{"$ref":"#/components/schemas/TransitNoticeDetail"}}},"required":["code"]},"TransitStop":{"type":"object","description":"A transit stop of the route","properties":{"departure":{"$ref":"#/components/schemas/TransitDeparture"},"duration":{"description":"Stop duration. If not set the vehicle departs as soon as people are on board.","type":"integer","example":198,"default":0},"transport":{"description":"Information about transit transport changes. If set, the vehicle changes its transit transport information,\nlike name, color, headsign etc, on this stop.\n","allOf":[{"$ref":"#/components/schemas/TransitTransport"}]},"offset":{"description":"The position of the stop on the polyline.","type":"integer"},"attributes":{"description":"**NOTE:** As it is possible that new attributes are supported in the future, unknown attributes should be ignored.\n","type":"array","items":{"$ref":"#/components/schemas/TransitStopAttributes"}}},"required":["departure"]},"VehicleNotice":{"example":{"$ref":"#/components/examples/noticeWithRestrictionsExample"},"type":"object","description":"A notice contains important notifications.","properties":{"title":{"type":"string","description":"Human-readable notice description.","example":"Violated avoid toll road"},"code":{"type":"string","description":"Extensible enum: `violatedAvoidControlledAccessHighway` `violatedAvoidTollRoad` `violatedAvoidTunnel` `violatedAvoidDirtRoad` `violatedBlockedRoad` `violatedStartDirection` `violatedCarpool` `violatedTurnRestriction` `violatedVehicleRestriction` `violatedZoneRestriction` `violatedAvoidDifficultTurns` `violatedAvoidUTurns` `violatedEmergencyGate` `violatedAvoidSeasonalClosure` `violatedAvoidTollTransponder` `violatedAvoidTruckRoadType` `seasonalClosure` `tollTransponder` `simplePolyline` `tollsDataUnavailable` `tollsDataTemporarilyUnavailable` `currencyUnsupported` `chargingStopNotNeeded` `violatedChargingStationOpeningHours` `violatedMinChargeAtDestination` `violatedMinChargeAtFirstChargingStation` `violatedMinChargeAtChargingStation` `outOfCharge` `currentWeightNegative` `currentWeightExceedsLimit` `travelTimeExceedsDriverWorkHours` `carpool` `turnRestriction` `vehicleRestriction` `zoneRestriction` `avoidTollRoad` `targetChargeNotAchievable` `violatedChargingStationTransportMode` `violatedChargingStationVehicleRestrictions` `maxDrivingTimeExceeded` `...` \nCurrently known codes (non-exhaustive: this list could 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| violatedAvoidTunnel | Route did not manage to avoid user preference. | critical |\n| violatedAvoidDirtRoad | Route did not manage to avoid user preference. | critical |\n| violatedBlockedRoad | Route uses roads that are blocked, due to traffic incidents, `avoid[areas]`, or `avoid[segments]`. | critical |\n| violatedStartDirection | The starting direction of the route differs from the value set in the `course` parameter of the waypoint. | critical |\n| violatedCarpool | Route did not manage to avoid user preference. | critical |\n| violatedTurnRestriction | Route requires performing a time-restricted maneuver at a time when it's prohibited. | critical |\n| violatedVehicleRestriction | Route uses a road which is forbidden for the given vehicle profile. | critical |\n| violatedZoneRestriction | Route uses a road in a user-specified avoidance zone, such as the London Low Emission Zone. | critical |\n| violatedAvoidDifficultTurns | Route did not manage to avoid user preference.| critical |\n| violatedAvoidUTurns | Route did not manage to avoid user preference. | critical |\n| violatedEmergencyGate | Route goes through an emergency gate. | critical |\n| violatedAvoidSeasonalClosure | Route did not manage to avoid a seasonal closure.| critical |\n| violatedAvoidTollTransponder | Route did not manage to avoid a toll booth that requires a transponder. | critical |\n| violatedAvoidTruckRoadType | Route did not manage to avoid truck road type. | critical |\n| seasonalClosure | Route goes through a seasonal closure. | info |\n| tollTransponder | Route goes through a toll booth that requires a transponder. | 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| tollsDataUnavailable | Tolls data was requested but could not be calculated for this section. | info |\n| tollsDataTemporarilyUnavailable | Tolls data was requested but is temporarily unavailable. | info |\n| currencyUnsupported | Provided currency is unsupported. | info |\n| chargingStopNotNeeded | A charging stop was planned at the destination of this section, but it is no longer needed (getRoutesByHandle requests only). | info |\n| violatedChargingStationOpeningHours | A charging stop was planned at the destination of this section, but the `postActions` would not be completed within the opening hours. | critical |\n| violatedMinChargeAtDestination | The `arrival.charge` at the destination is lower than the `minChargeAtDestination`. | info |\n| violatedMinChargeAtFirstChargingStation | The `arrival.charge` on the first charging stop is lower than the `minChargeAtFirstChargingStation`. | info |\n| violatedMinChargeAtChargingStation | The `arrival.charge` on a charging station stop is lower than the `minChargeAtChargingStation`. This can be on the first charging stop if `minChargeAtFirstChargingStation` is not specified. | info |\n| outOfCharge | The charge of the EV drops below 0 along the section. | info |\n| currentWeightNegative | `vehicle[currentWeight]` is negative after applying `currentWeightChange` at a via waypoint. | critical |\n| currentWeightExceedsLimit | `vehicle[currentWeight]` exceeds limit for given `transportMode`. | critical |\n| travelTimeExceedsDriverWorkHours | The route travelTime exceeds drive time sequence provided in `driver[schedule]` parameter. | critical |\n| targetChargeNotAchievable | `ev[MaxChargingDuration]` too short to achieve required charging level. | info |\n| violatedChargingStationTransportMode | Provided `transportMode` is not permitted at the charging station | critical |\n| violatedChargingStationVehicleRestrictions | One or more vehicle attributes exceed the permitted vehicle limits of the charging station | critical |\n| maxDrivingTimeExceeded | Desired maximum driving time before first charge exceeded | info |\n\n\nThe codes listed below can appear as info notices when the request contains `return=potentialTimeDependentViolations`.\nThe resulting info notices are not violations on the current route but could be violations if the arrival time\nat these restrictions differs from the calculated time.\nFor example, an info notice for a `vehicleRestriction` could indicate that while your vehicle is not currently violating any restriction.\nHowever, if the journey is delayed by an hour the vehicle would not be allowed on part of the route because there is a time-dependent restriction active at that time.\n\nCodes for potential time dependent restriction violations are (non-exhaustive: can be extended for new situations):\n\n| Code | Description | Severity |\n| --------- | ------- | ------- |\n| carpool | Route potentially uses a carpool only road when not allowed. | info |\n| turnRestriction | Route potentially uses a time-restricted turn when not allowed. | info |\n| vehicleRestriction | Route potentially uses a road that is forbidden for the given vehicle profile. | info |\n| zoneRestriction | Route uses a road that is potentially part of restricted routing zones. | info |\n| avoidTollRoad | Route uses a road that potentially is a toll road. **Note:** This is not currently supported and will not be returned, but the enum value is retained for backwards-compatibility purposes. | info |\n","example":"violatedAvoidTollRoad","x-extensible-enum":["violatedAvoidControlledAccessHighway","violatedAvoidTollRoad","violatedAvoidTunnel","violatedAvoidDirtRoad","violatedBlockedRoad","violatedStartDirection","violatedCarpool","violatedTurnRestriction","violatedVehicleRestriction","violatedZoneRestriction","violatedAvoidDifficultTurns","violatedAvoidUTurns","violatedEmergencyGate","violatedAvoidSeasonalClosure","violatedAvoidTollTransponder","violatedAvoidTruckRoadType","seasonalClosure","tollTransponder","simplePolyline","tollsDataUnavailable","tollsDataTemporarilyUnavailable","currencyUnsupported","chargingStopNotNeeded","violatedChargingStationOpeningHours","violatedMinChargeAtDestination","violatedMinChargeAtFirstChargingStation","violatedMinChargeAtChargingStation","outOfCharge","currentWeightNegative","currentWeightExceedsLimit","travelTimeExceedsDriverWorkHours","carpool","turnRestriction","vehicleRestriction","zoneRestriction","avoidTollRoad","targetChargeNotAchievable","violatedChargingStationTransportMode","violatedChargingStationVehicleRestrictions","maxDrivingTimeExceeded"]},"severity":{"$ref":"#/components/schemas/NoticeSeverity"},"details":{"type":"array","description":"Additional details about the notice","items":{"$ref":"#/components/schemas/VehicleNoticeDetail"}}},"required":["code"]},"VehiclePlace":{"description":"Place used in vehicle routing.","oneOf":[{"$ref":"#/components/schemas/Place"},{"$ref":"#/components/schemas/StationPlace"},{"$ref":"#/components/schemas/AccessPointPlace"},{"$ref":"#/components/schemas/ParkingLotPlace"},{"$ref":"#/components/schemas/ChargingStationPlace"},{"$ref":"#/components/schemas/DockingStationPlace"}],"discriminator":{"propertyName":"type","mapping":{"place":"#/components/schemas/Place","station":"#/components/schemas/StationPlace","accessPoint":"#/components/schemas/AccessPointPlace","parkingLot":"#/components/schemas/ParkingLotPlace","chargingStation":"#/components/schemas/ChargingStationPlace","dockingStation":"#/components/schemas/DockingStationPlace"}}},"AreasPost":{"description":"List of user-defined areas that routes should avoid/exclude going through.\n\nNotes:\n* Maximum count of avoided and excluded polygons and corridors is 20.\n* Maximum total count of avoided and excluded bounding boxes, polygons, corridors, including exceptions, is 250.\n","type":"array","maxItems":250,"items":{"$ref":"#/components/schemas/AreaPost"},"example":{"areas":[{"type":"polygon","outer":[{"lat":52.514414,"lng":13.384685},{"lat":52.514414,"lng":13.393568},{"lat":52.512403,"lng":13.393568},{"lat":52.512403,"lng":13.384685}]},{"type":"encodedPolygon","outer":"BG8mnlkD6-9wZAmrR19DAAlrR"},{"type":"boundingBox","west":1.1,"south":2.2,"east":3.3,"north":4.4,"exceptions":[{"type":"polygon","outer":[{"lat":52.514414,"lng":13.384685},{"lat":52.514414,"lng":13.393568},{"lat":52.512403,"lng":13.393568},{"lat":52.512403,"lng":13.384685}]},{"type":"encodedPolygon","outer":"BG8mnlkD6-9wZAmrR19DAAlrR"}]}]}},"ArriveAction":{"description":"An arrival maneuver to be performed at or during a specific portion of a section.\n","type":"object","properties":{"action":{"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","type":"string","enum":["arrive"]},"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":{"description":"Description of the action (e.g. Turn left onto Minna St.).","type":"string"},"offset":{"description":"Offset of a coordinate in the section's polyline.","type":"integer","example":0},"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"}]},"signpost":{"description":"Signpost information of the action, provided for turn by turn actions only","allOf":[{"$ref":"#/components/schemas/SignpostInfo"}]}},"required":["action","duration"]},"ContinueAction":{"description":"A continue operation to be performed at or during a specific portion of a section.\n","type":"object","properties":{"action":{"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","type":"string","enum":["continue"]},"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":{"description":"Description of the action (e.g. Turn left onto Minna St.).","type":"string"},"offset":{"description":"Offset of a coordinate in the section's polyline.","type":"integer","example":0},"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"}]},"signpost":{"description":"Signpost information of the action, provided for turn by turn actions only","allOf":[{"$ref":"#/components/schemas/SignpostInfo"}]},"intersectionName":{"description":"Name of the intersection where the turn takes place, if available.","type":"array","items":{"$ref":"#/components/schemas/LocalizedString"}}},"required":["action","duration"]},"DepartAction":{"description":"A departure maneuver to be performed at or during a specific portion of a section.\n","type":"object","properties":{"action":{"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","type":"string","enum":["depart"]},"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":{"description":"Description of the action (e.g. Turn left onto Minna St.).","type":"string"},"offset":{"description":"Offset of a coordinate in the section's polyline.","type":"integer","example":0},"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"}]},"signpost":{"description":"Signpost information of the action, provided for turn by turn actions only","allOf":[{"$ref":"#/components/schemas/SignpostInfo"}]}},"required":["action","duration"]},"PedestrianDeparture":{"type":"object","description":"Departure of pedestrian","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"}},"required":["place"]},"TollCost":{"type":"object","description":"Information for a single toll payment.\n","properties":{"tollSystem":{"description":"The name of the toll system collecting the toll.\n\n**NOTE** This property is deprecated. For a toll cost associated with multiple toll systems this parameter will\nreturn only one toll system name. Use `tollSystems` property to get all the systems.\n","type":"string","deprecated":true},"tollSystemRef":{"description":"Reference index of the affected toll system in the `tollSystems` array.\n\n**NOTE** This property is deprecated. For a toll cost associated with multiple systems this parameter will return only one system. Use `tollSystems` property to get all the systems.\n","type":"integer","deprecated":true},"tollSystems":{"description":"Reference indices of the associated toll system(s). These indices correspond to the `tollSystems` array in the enclosing section.\n\nA toll cost may be associated with multiple systems. For details, refer to this Developer Guide [tutorial](https://docs.here.com/routing/docs/routing-v8-tolls-multiple-systems).\n","type":"array","items":{"type":"integer"}},"countryCode":{"$ref":"#/components/schemas/CountryCode"},"tollCollectionLocations":{"description":"The toll places represent the location(s) where the fare is collected. For tolls measured by distance, both the entry and exit toll locations are returned. It's important to note that while both entry and exit toll locations are provided, the payment is typically made at only one of these places, which is usually the exit toll location.\n","type":"array","items":{"$ref":"#/components/schemas/TollCollectionLocation"}},"fares":{"description":"The list of possible `Fare`s represents the various fares that may apply for the tolls. The specific fares can vary based on factors such as the time of day, payment method, and vehicle characteristics.\n\n**Note**: The router presents the relevant fare options based on the original query, on a best effort basis.\nThe `Fare` object for tolls will always be of type `SinglePrice`, indicating a single price for the toll.\n","type":"array","items":{"$ref":"#/components/schemas/TollFare"}}},"required":["tollSystem","tollSystemRef","fares"]},"TurnAction":{"description":"An action in which a direction change is made.\n","type":"object","properties":{"action":{"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","type":"string","enum":["turn","ramp","roundaboutPass","roundaboutEnter","uTurn","enterHighway","keep","continueHighway"]},"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":{"description":"Description of the action (e.g. Turn left onto Minna St.).","type":"string"},"offset":{"description":"Offset of a coordinate in the section's polyline.","type":"integer","example":0},"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"}]},"signpost":{"description":"Signpost information of the action, provided for turn by turn actions only","allOf":[{"$ref":"#/components/schemas/SignpostInfo"}]},"intersectionName":{"description":"Name of the intersection where the turn takes place, if available.","type":"array","items":{"$ref":"#/components/schemas/LocalizedString"}},"direction":{"description":"Note that the direction of a turn has a special meaning for \"roundaboutEnter\": It indicates the direction in which one drives around the roundabout (left for left-hand-side driving countries, right for right-hand-side ones).\n","allOf":[{"$ref":"#/components/schemas/TurnActionDirection"}]},"severity":{"$ref":"#/components/schemas/TurnActionSeverity"},"turnAngle":{"$ref":"#/components/schemas/TurnAngle"}},"required":["action","duration"]},"VehicleDeparture":{"type":"object","description":"Describe a departure or arrival location and time.","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":{"description":"Vehicle battery charge, specified in kilowatt-hours (kWh).","type":"number"}},"required":["place"]},"VehicleSummary":{"type":"object","description":"Total value of key attributes for a route section.","properties":{"duration":{"$ref":"#/components/schemas/Duration"},"length":{"$ref":"#/components/schemas/Distance"},"baseDuration":{"description":"The duration, specified in seconds, without taking time-aware information into account.\n\nDynamic traffic information is not considered. The duration is calculated using average free-flow speeds based on historical traffic, without taking into account the current traffic conditions.\n\nThe actual duration of the route section may be lower than `baseDuration` in some cases, e.g. if `trafficSpeed` is greater than `baseSpeed`.\n","allOf":[{"$ref":"#/components/schemas/Duration"}]},"consumption":{"description":"The estimated net energy or fuel consumption along a span of the route is provided based on the `consumptionType` of the section. The value represents either net energy consumption or fuel consumption. Here are the units used for different vehicle types:\n* For electric vehicles (EVs): The energy consumption is measured in kilowatt-hours (kWh). This indicates the amount of energy consumed by the EV while traversing the specific span.\n* For fuel-based vehicles: Depending on the fuel type, the fuel consumption is measured in liters (for diesel, petrol vehicles, and vehicles using liquefied petroleum gas (LPG)), and in kilograms (for vehicles using compressed natural gas (CNG)).\n","allOf":[{"$ref":"#/components/schemas/Consumption"}]},"typicalDuration":{"description":"The duration, specified in seconds, under typical traffic conditions.\n\nDynamic traffic information is not considered. Instead, the duration is calculated using speeds that are typical for the given time of day/day of week, based on historical traffic data.\n","allOf":[{"$ref":"#/components/schemas/Duration"}]},"tolls":{"description":"The summary of tolls to be paid for this section of the route, grouped according to the criteria specified in the `tolls` parameter.\nThis element is included in the response if at least one grouping criteria was requested.\n","allOf":[{"$ref":"#/components/schemas/TollSummary"}]},"co2Emission":{"description":"Estimation of the carbon dioxide emission for the given route section. Unit is kilograms with precision to three decimal places.\n\nDefinitions:\n\n* Total Emission (Well-to-Wheel) = Production Emission (Well-to-Tank) + Operational Emission (Tank-to-Wheel)\n* CO2 Equivalent Emission (CO2e for CH4, N2O, etc.) = Gas Emission * Global Warming Potential (GWP)\n\n**Notes:**\n\n* This value represents the operational (tank-to-wheel) carbon dioxide emission.\n* This value represents only the carbon dioxide emission and does not represent the carbon dioxide equivalent emission for other gases or particulates.\n* This value is calculated based on `fuel[type]`, the `consumption` for the given route section and the `fuel emission factor` provided in this document. The calculation does not adhere to any other standards (e.g. ISO 14083, etc.).\n* `co2Emission` is only returned for `fuel` based vehicle.\n\nEmission factors for different fuel types:\n\n* `diesel`: Diesel. Emission is 2.697 kg of CO2 from each combusted liter of fuel.\n* `petrol`: Petrol/gasoline. Emission is 2.319 kg of CO2 from each combusted liter of fuel.\n* `lpg`: LPG. Emission is 1.5 kg of CO2 from each combusted liter of fuel.\n* `cng`: CNG. Emission is 2.529 kg of CO2 from each combusted kilogram of fuel.\n* `lng`: LNG. Emission is 1.189 kg of CO2 from each combusted liter of fuel.\n* `ethanol`: Ethanol (100%). Emission is 1.519 kg of CO2 from each combusted liter of fuel.\n* `propane`: Propane. Emission is 1.511 kg of CO2 from each combusted liter of fuel.\n* `hydrogen`: Hydrogen (emission for production is not considered). Emission is 0 kg of CO2 from each combusted liter of fuel.\n\nSource for Emission Factors:\n* [Table(2) Mobile Combustion (CO2) - Emission Factors for Greenhouse Gas Inventories (2024): EPA GHG Emission Factors Hub](https://www.epa.gov/climateleadership/ghg-emission-factors-hub)\n* Some data may be from a previous year if data is not available for 2024.\n","allOf":[{"$ref":"#/components/schemas/CO2Emission"}]}},"required":["duration","length"]},"VehicleTravelSummary":{"type":"object","description":"Total value of key attributes for a route section.","properties":{"duration":{"$ref":"#/components/schemas/Duration"},"length":{"$ref":"#/components/schemas/Distance"},"baseDuration":{"description":"The duration, specified in seconds, without taking time-aware information into account.\n\nDynamic traffic information is not considered. The duration is calculated using average free-flow speeds based on historical traffic, without taking into account the current traffic conditions.\n\nThe actual duration of the route section may be lower than `baseDuration` in some cases, e.g. if `trafficSpeed` is greater than `baseSpeed`.\n","allOf":[{"$ref":"#/components/schemas/Duration"}]},"consumption":{"description":"The estimated net energy or fuel consumption for the travel only. It is based on the `consumptionType` of the section. The value represents either net energy consumption or fuel consumption. Here are the units used for different vehicle types:\n* For electric vehicles (EVs): The energy consumption is measured in kilowatt-hours (kWh) and does not include any charging at stations.\n* For fuel-based vehicles: Depending on the fuel type, the fuel consumption is measured in liters (for diesel, petrol vehicles, and vehicles using liquefied petroleum gas (LPG)), and in kilograms (for vehicles using compressed natural gas (CNG)).\n","allOf":[{"$ref":"#/components/schemas/Consumption"}]},"typicalDuration":{"description":"The duration, specified in seconds, under typical traffic conditions.\n\nDynamic traffic information is not considered. Instead, the duration is calculated using speeds that are typical for the given time of day/day of week, based on historical traffic data.\n","allOf":[{"$ref":"#/components/schemas/Duration"}]},"tolls":{"description":"The summary of tolls to be paid for this section of the route, grouped according to the criteria specified in the `tolls` parameter.\nThis element is included in the response if at least one grouping criteria was requested.\n","allOf":[{"$ref":"#/components/schemas/TollSummary"}]},"co2Emission":{"description":"Estimation of the carbon dioxide emission for the given route section. Unit is kilograms with precision to three decimal places.\n\nDefinitions:\n\n* Total Emission (Well-to-Wheel) = Production Emission (Well-to-Tank) + Operational Emission (Tank-to-Wheel)\n* CO2 Equivalent Emission (CO2e for CH4, N2O, etc.) = Gas Emission * Global Warming Potential (GWP)\n\n**Notes:**\n\n* This value represents the operational (tank-to-wheel) carbon dioxide emission.\n* This value represents only the carbon dioxide emission and does not represent the carbon dioxide equivalent emission for other gases or particulates.\n* This value is calculated based on `fuel[type]`, the `consumption` for the given route section and the `fuel emission factor` provided in this document. The calculation does not adhere to any other standards (e.g. ISO 14083, etc.).\n* `co2Emission` is only returned for `fuel` based vehicle.\n\nEmission factors for different fuel types:\n\n* `diesel`: Diesel. Emission is 2.697 kg of CO2 from each combusted liter of fuel.\n* `petrol`: Petrol/gasoline. Emission is 2.319 kg of CO2 from each combusted liter of fuel.\n* `lpg`: LPG. Emission is 1.5 kg of CO2 from each combusted liter of fuel.\n* `cng`: CNG. Emission is 2.529 kg of CO2 from each combusted kilogram of fuel.\n* `lng`: LNG. Emission is 1.189 kg of CO2 from each combusted liter of fuel.\n* `ethanol`: Ethanol (100%). Emission is 1.519 kg of CO2 from each combusted liter of fuel.\n* `propane`: Propane. Emission is 1.511 kg of CO2 from each combusted liter of fuel.\n* `hydrogen`: Hydrogen (emission for production is not considered). Emission is 0 kg of CO2 from each combusted liter of fuel.\n\nSource for Emission Factors:\n* [Table(2) Mobile Combustion (CO2) - Emission Factors for Greenhouse Gas Inventories (2024): EPA GHG Emission Factors Hub](https://www.epa.gov/climateleadership/ghg-emission-factors-hub)\n* Some data may be from a previous year if data is not available for 2024.\n","allOf":[{"$ref":"#/components/schemas/CO2Emission"}]}},"required":["duration","length"]},"AvoidPost":{"type":"object","description":"Avoid routes that violate certain features of road network or that go through\nuser-specified geographical bounding boxes.\n\nFor the general description of the functionality please refer to the `avoid` parameter of the\nquery string.\n\nPassing parameters in the POST body is suggested when the length of the parameters exceeds the\nlimitation of the GET request.\n","properties":{"segments":{"description":"An array of segment identifiers that routes will avoid going through.\n\nEach entry has the following structure:\n`{segmentId}(#{direction})?`\n\nThe individual parts are:\n* segmentId: The identifier of the referenced topology segment inside the catalog, example: `here:cm:segment:207551710`\n* direction (optional): Either '*' for bidirectional (default), '+' for positive direction, or '-' for negative direction\n\nExample of a parameter value excluding two segments:\n`[\"here:cm:segment:207551710#+\", \"here:cm:segment:76771992#*\"]`\n\n**Note**: Maximum number of penalized segments in one request should not be greater than 1000.\n \"Penalized segments\" refers to segments that have a restriction on maximum baseSpeed with `maxSpeedOnSegment`\n or avoided with `avoid[segments]`\n","type":"array","items":{"type":"string"}},"areas":{"$ref":"#/components/schemas/AreasPost"}}},"ExcludePost":{"type":"object","description":"User-specified properties that need to be strictly excluded during route calculation.\n\nFor the general description of the functionality please refer to the `exclude` parameter of the\nquery string.\n\nPassing parameters in the POST body is suggested when the length of the parameters exceeds the\nlimitation of the GET request.\n","properties":{"areas":{"$ref":"#/components/schemas/AreasPost"}}},"ExitAction":{"description":"An action to leave a highway or roundabout.\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","type":"object","properties":{"action":{"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","type":"string","enum":["exit","roundaboutExit"]},"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":{"description":"Description of the action (e.g. Turn left onto Minna St.).","type":"string"},"offset":{"description":"Offset of a coordinate in the section's polyline.","type":"integer","example":0},"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"}]},"signpost":{"description":"Signpost information of the action, provided for turn by turn actions only","allOf":[{"$ref":"#/components/schemas/SignpostInfo"}]},"intersectionName":{"description":"Name of the intersection where the turn takes place, if available.","type":"array","items":{"$ref":"#/components/schemas/LocalizedString"}},"direction":{"description":"Note that the direction of a turn has a special meaning for \"roundaboutEnter\": It indicates the direction in which one drives around the roundabout (left for left-hand-side driving countries, right for right-hand-side ones).\n","allOf":[{"$ref":"#/components/schemas/TurnActionDirection"}]},"severity":{"$ref":"#/components/schemas/TurnActionSeverity"},"turnAngle":{"$ref":"#/components/schemas/TurnAngle"},"exit":{"description":"Which exit to take next.","type":"integer","minimum":1,"maximum":12,"default":1},"roundaboutAngle":{"$ref":"#/components/schemas/RoundaboutAngle"}},"required":["action","duration"]},"KeepAction":{"description":"Keep maneuver, such as \"Take the middle fork onto\"\n","type":"object","properties":{"action":{"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","type":"string","enum":["keep"]},"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":{"description":"Description of the action (e.g. Turn left onto Minna St.).","type":"string"},"offset":{"description":"Offset of a coordinate in the section's polyline.","type":"integer","example":0},"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"}]},"signpost":{"description":"Signpost information of the action, provided for turn by turn actions only","allOf":[{"$ref":"#/components/schemas/SignpostInfo"}]},"intersectionName":{"description":"Name of the intersection where the turn takes place, if available.","type":"array","items":{"$ref":"#/components/schemas/LocalizedString"}},"direction":{"description":"Note that the direction of a turn has a special meaning for \"roundaboutEnter\": It indicates the direction in which one drives around the roundabout (left for left-hand-side driving countries, right for right-hand-side ones).\n","allOf":[{"$ref":"#/components/schemas/TurnActionDirection"}]},"severity":{"$ref":"#/components/schemas/TurnActionSeverity"},"turnAngle":{"$ref":"#/components/schemas/TurnAngle"}},"required":["action","duration"]},"SimpleTurnAction":{"description":"Turn maneuver, such as \"Make a sharp right turn at\"\n","type":"object","properties":{"action":{"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","type":"string","enum":["turn"]},"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":{"description":"Description of the action (e.g. Turn left onto Minna St.).","type":"string"},"offset":{"description":"Offset of a coordinate in the section's polyline.","type":"integer","example":0},"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"}]},"signpost":{"description":"Signpost information of the action, provided for turn by turn actions only","allOf":[{"$ref":"#/components/schemas/SignpostInfo"}]},"intersectionName":{"description":"Name of the intersection where the turn takes place, if available.","type":"array","items":{"$ref":"#/components/schemas/LocalizedString"}},"direction":{"description":"Note that the direction of a turn has a special meaning for \"roundaboutEnter\": It indicates the direction in which one drives around the roundabout (left for left-hand-side driving countries, right for right-hand-side ones).\n","allOf":[{"$ref":"#/components/schemas/TurnActionDirection"}]},"severity":{"$ref":"#/components/schemas/TurnActionSeverity"},"turnAngle":{"$ref":"#/components/schemas/TurnAngle"}},"required":["action","duration"]},"TransitAction":{"description":"Action attached to a transit section.","oneOf":[{"$ref":"#/components/schemas/DepartAction"},{"$ref":"#/components/schemas/ArriveAction"},{"$ref":"#/components/schemas/ContinueAction"}],"discriminator":{"propertyName":"action","mapping":{"depart":"#/components/schemas/DepartAction","arrive":"#/components/schemas/ArriveAction","continue":"#/components/schemas/ContinueAction"}}},"TransitTurnByTurnAction":{"oneOf":[{"$ref":"#/components/schemas/DepartAction"}],"discriminator":{"propertyName":"action","mapping":{"depart":"#/components/schemas/DepartAction"}}},"CalculateRoutesPostParameters":{"description":"Parameters of the POST body for route calculation","type":"object","properties":{"avoid":{"$ref":"#/components/schemas/AvoidPost"},"exclude":{"$ref":"#/components/schemas/ExcludePost"},"ev":{"$ref":"#/components/schemas/EVPost"},"maxSpeedOnSegment":{"$ref":"#/components/schemas/MaxSpeedOnSegmentPost"},"networkRestrictedTruck":{"$ref":"#/components/schemas/NetworkRestrictedTruckPost"}}},"GetRoutesByHandlePostParameters":{"description":"Parameters of the POST body for get route by handle","type":"object","properties":{"avoid":{"$ref":"#/components/schemas/AvoidPost"},"exclude":{"$ref":"#/components/schemas/ExcludePost"},"maxSpeedOnSegment":{"$ref":"#/components/schemas/MaxSpeedOnSegmentPost"},"networkRestrictedTruck":{"$ref":"#/components/schemas/NetworkRestrictedTruckPost"}}},"PedestrianAction":{"description":"Action attached to a pedestrian section.","oneOf":[{"$ref":"#/components/schemas/DepartAction"},{"$ref":"#/components/schemas/ArriveAction"},{"$ref":"#/components/schemas/ContinueAction"},{"$ref":"#/components/schemas/ExitAction"},{"$ref":"#/components/schemas/SimpleTurnAction"},{"$ref":"#/components/schemas/KeepAction"}],"discriminator":{"propertyName":"action","mapping":{"depart":"#/components/schemas/DepartAction","arrive":"#/components/schemas/ArriveAction","continue":"#/components/schemas/ContinueAction","exit":"#/components/schemas/ExitAction","turn":"#/components/schemas/SimpleTurnAction","keep":"#/components/schemas/KeepAction"}}},"TransitSection":{"type":"object","description":"A section of the route. It contains departure, arrival, and route information.","properties":{"id":{"description":"Unique identifier of the section","type":"string"},"type":{"description":"Section type used by the client to identify what extension to the BaseSection are available.","type":"string","enum":["transit"]},"preActions":{"description":"Actions that must be done prior to `departure`.","type":"array","items":{"$ref":"#/components/schemas/TransitPreAction"}},"actions":{"description":"Actions that must be done during the travel portion of the section.\n\nAction offsets represent the coordinate index in the polyline.\n\n*NOTE:* currentRoad and nextRoad are not populated for actions.\n","type":"array","items":{"$ref":"#/components/schemas/TransitAction"}},"language":{"description":"Language of the localized strings in the section, if any, in BCP47 format.","type":"string"},"postActions":{"description":"Actions that must be done after `arrival`.","type":"array","items":{"$ref":"#/components/schemas/TransitPostAction"}},"turnByTurnActions":{"description":"Actions for turn by turn guidance during the travel portion of the section, i.e., between `departure` and `arrival`.","type":"array","items":{"$ref":"#/components/schemas/TransitTurnByTurnAction"}},"departure":{"$ref":"#/components/schemas/TransitDeparture"},"arrival":{"$ref":"#/components/schemas/TransitDeparture"},"passthrough":{"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","type":"array","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":{"description":"Contains a list of issues related to this section of the route.\n","type":"array","items":{"$ref":"#/components/schemas/TransitNotice"}},"bookingLinks":{"description":"Links to external ticket booking services","type":"array","items":{"$ref":"#/components/schemas/WebLinkWithDeviceType"}},"transport":{"$ref":"#/components/schemas/TransitTransport"},"intermediateStops":{"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","type":"array","items":{"$ref":"#/components/schemas/TransitStop"}},"agency":{"$ref":"#/components/schemas/Agency"},"attributions":{"description":"List of required attributions to display.","type":"array","items":{"$ref":"#/components/schemas/Attribution"}},"fares":{"description":"\"List of tickets to pay for this section of the route\"\n\n**NOTE**: Fares information support will be available soon.\n","type":"array","items":{"$ref":"#/components/schemas/Fare"}},"booking":{"description":"**NOTE:** Attribute booking is deprecated. Please, use bookingLinks instead of it.\n","deprecated":true,"allOf":[{"$ref":"#/components/schemas/WebLink"}]},"spans":{"type":"array","description":"Span attached to a `Section` describing transit content.\n","items":{"$ref":"#/components/schemas/TransitSpan"}},"refReplacements":{"$ref":"#/components/schemas/RefReplacements"},"incidents":{"description":"A list of all incidents that apply to the section.","type":"array","items":{"$ref":"#/components/schemas/TransitIncident"}}},"required":["id","type","departure","arrival"]},"VehicleAction":{"description":"Action attached to a vehicle section.","oneOf":[{"$ref":"#/components/schemas/DepartAction"},{"$ref":"#/components/schemas/ArriveAction"},{"$ref":"#/components/schemas/ContinueAction"},{"$ref":"#/components/schemas/ExitAction"},{"$ref":"#/components/schemas/TurnAction"}],"discriminator":{"propertyName":"action","mapping":{"depart":"#/components/schemas/DepartAction","arrive":"#/components/schemas/ArriveAction","continue":"#/components/schemas/ContinueAction","ramp":"#/components/schemas/TurnAction","exit":"#/components/schemas/ExitAction","roundaboutPass":"#/components/schemas/TurnAction","roundaboutEnter":"#/components/schemas/TurnAction","roundaboutExit":"#/components/schemas/ExitAction","uTurn":"#/components/schemas/TurnAction","turn":"#/components/schemas/TurnAction","keep":"#/components/schemas/TurnAction","enterHighway":"#/components/schemas/TurnAction","continueHighway":"#/components/schemas/TurnAction"}}},"PedestrianSection":{"type":"object","description":"Represent a section of a route","properties":{"id":{"description":"Unique identifier of the section","type":"string"},"type":{"description":"Section type used by the client to identify what extension to the BaseSection are available.","type":"string","enum":["pedestrian"]},"preActions":{"description":"Actions that must be done prior to `departure`.","type":"array","items":{"$ref":"#/components/schemas/BaseAction"}},"actions":{"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\n*NOTE:* currentRoad and nextRoad are not populated for actions.\n","type":"array","items":{"$ref":"#/components/schemas/PedestrianAction"}},"language":{"description":"Language of the localized strings in the section, if any, in BCP47 format.","type":"string"},"postActions":{"description":"Actions that must be done after `arrival`.","type":"array","items":{"$ref":"#/components/schemas/PedestrianPostAction"}},"turnByTurnActions":{"description":"Actions for turn by turn guidance during the travel portion of the section, i.e., between `departure` and `arrival`.","type":"array","items":{"$ref":"#/components/schemas/OffsetAction"}},"departure":{"$ref":"#/components/schemas/PedestrianDeparture"},"arrival":{"$ref":"#/components/schemas/PedestrianDeparture"},"passthrough":{"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","type":"array","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":{"description":"Contains a list of issues related to this section of the route.\n","type":"array","items":{"$ref":"#/components/schemas/PedestrianNotice"}},"transport":{"$ref":"#/components/schemas/PedestrianTransport"},"spans":{"description":"Spans attached to a `Section` describing pedestrian content.\n","type":"array","items":{"$ref":"#/components/schemas/PedestrianSpan"}},"refReplacements":{"$ref":"#/components/schemas/RefReplacements"}},"required":["id","type","departure","arrival","transport"]},"VehicleSection":{"type":"object","description":"Represent a section of a route","properties":{"id":{"description":"Unique identifier of the section","type":"string"},"type":{"description":"Section type used by the client to identify what extension to the BaseSection are available.","type":"string","enum":["vehicle"]},"preActions":{"description":"Actions that must be done prior to `departure`.","type":"array","items":{"$ref":"#/components/schemas/BaseAction"}},"actions":{"description":"Actions to be performed at or during a specific portion of a section.\n\nAction offsets represent the coordinate index in the polyline.\n\n*NOTE:* The following attributes are valid for turnByTurnActions only and are not populated for actions\n * currentRoad\n * nextRoad\n * exitSign\n * signPost\n * intersectionName\n * turnAngle\n","type":"array","items":{"$ref":"#/components/schemas/VehicleAction"}},"language":{"description":"Language of the localized strings in the section, if any, in BCP47 format.","type":"string"},"postActions":{"description":"Actions that must be done after `arrival`.","type":"array","items":{"$ref":"#/components/schemas/VehiclePostAction"}},"turnByTurnActions":{"description":"Turn-by-turn guidance actions.\n\nAction offsets represent the coordinate index in the polyline.\n","type":"array","items":{"$ref":"#/components/schemas/VehicleAction"}},"departure":{"$ref":"#/components/schemas/VehicleDeparture"},"arrival":{"$ref":"#/components/schemas/VehicleDeparture"},"passthrough":{"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","type":"array","items":{"$ref":"#/components/schemas/Passthrough"}},"summary":{"description":"The total value of key attributes, such as duration, length, and consumption, summed up for the entire section, including `preActions`, `postActions`, and the travel portion of the section.\n","allOf":[{"$ref":"#/components/schemas/VehicleSummary"}]},"travelSummary":{"description":"The total value of key attributes, such as duration, length, and consumption, summed up only for the travel portion of the section,\nbetween `departure` and `arrival`. `preActions` and `postActions` are excluded.\n","allOf":[{"$ref":"#/components/schemas/VehicleTravelSummary"}]},"polyline":{"$ref":"#/components/schemas/Polyline"},"notices":{"description":"Contains a list of issues related to this section of the route.\n\nNotices must be carefully evaluated and, if deemed necessary, the route section should be discarded accordingly.\nIn particular, the user should be aware that new notice codes may be added at any time. 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","type":"array","items":{"$ref":"#/components/schemas/VehicleNotice"}},"spans":{"description":"Spans attached to a `Section` describing vehicle content.\n","type":"array","items":{"$ref":"#/components/schemas/VehicleSpan"}},"routingZones":{"description":"A list of routing zones that are applicable to the section.\n\nElements of this list will be referenced by indexes within the `span` attribute of the section.\n","type":"array","items":{"$ref":"#/components/schemas/RoutingZone"}},"truckRoadTypes":{"description":"A list of truck road types that are applicable to the section.\n\nElements of this list will be referenced by indexes within the `span` attribute of the section.\n\nA truck road type is an identifier associated with roads that have additional regulations applied by local administration for\ntraversal by heavy vehicles like trucks. For example, the BK Bearing Class regulations in Sweden, and ET categories in Mexico.\nThe identifiers of supported truck road types are specified at HERE Map Content\n[TruckRoadType](https://docs.here.com/map-content/docs/truckroadtypeattribute).\n\nThese names should be provided when avoiding a certain truck road type.\n","type":"array","items":{"type":"string"}},"incidents":{"description":"A list of all incidents that apply to the section.","type":"array","items":{"$ref":"#/components/schemas/TrafficIncident"}},"refReplacements":{"$ref":"#/components/schemas/RefReplacements"},"tollSystems":{"description":"An array of toll authorities that collect payments for the use of (part of) the specified section of the route.\n","type":"array","items":{"$ref":"#/components/schemas/TollSystem"}},"tolls":{"description":"Detail of tolls to be paid for traversing the specified section.\n","type":"array","items":{"$ref":"#/components/schemas/TollCost"}},"consumptionType":{"description":"Vehicle energy or fuel consumption type.","allOf":[{"$ref":"#/components/schemas/ConsumptionType"}]},"noThroughRestrictions":{"description":"A list of all rules that restrict movement through the area without there being an\norigin, destination, or `via` waypoint inside of it. Only restrictions applicable\nto the vehicle for which the route was requested are returned.\n","type":"array","items":{"$ref":"#/components/schemas/VehicleRestriction"}},"transport":{"$ref":"#/components/schemas/VehicleTransport"}},"required":["id","type","departure","arrival","transport"]},"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","oneOf":[{"$ref":"#/components/schemas/VehicleSection"},{"$ref":"#/components/schemas/PedestrianSection"},{"$ref":"#/components/schemas/TransitSection"}],"discriminator":{"propertyName":"type","mapping":{"vehicle":"#/components/schemas/VehicleSection","pedestrian":"#/components/schemas/PedestrianSection","transit":"#/components/schemas/TransitSection"}}},"RouterRoute":{"type":"object","description":"A basic route. Includes personal vehicles as car, truck, etc... For all modes, cf. `transportMode`.\n","properties":{"id":{"description":"Unique identifier of the route","type":"string"},"notices":{"description":"Contains a list of issues encountered during the processing of this response.","type":"array","items":{"$ref":"#/components/schemas/Notice"}},"sections":{"type":"array","items":{"$ref":"#/components/schemas/RouterSection"},"description":"An ordered list of vehicle, transit, and pedestrian sections making up the route.\n"},"routeLabels":{"description":"Contains a list of the most important names and route numbers on this route that differentiate it from other alternatives.\nThese names are used to make labels for the main and alternative routes, like \"route1 via A4,D10\", \"route2 via D11,5\"\nThe generated list is expected to be unique for each route in response (but it's not guaranteed)\n","type":"array","items":{"$ref":"#/components/schemas/RouteLabel"},"minItems":0,"maxItems":2},"routeHandle":{"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 `routeHandle` property is\nnot available in the response. The rest of the route is intact.\n","type":"string"}},"required":["id","sections"]},"RouterRouteResponse":{"type":"object","description":"Returns a list of routes.","properties":{"notices":{"description":"Contains a list of issues related to this route calculation.\nPlease refer to the `code` attribute for possible values.\n","type":"array","items":{"$ref":"#/components/schemas/RouteResponseNotice"}},"routes":{"description":"List of possible routes","type":"array","items":{"$ref":"#/components/schemas/RouterRoute"}}},"required":["routes"]}},"responses":{"401ErrorResponseWithRequestID":{"description":"API response in case of unauthorized access.","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/SimpleErrorResponseSchema"},"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":{"schema":{"type":"string"}}}},"HealthResponseOkWithRequestID":{"headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"description":"API response in case of success.","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"}}}}},"OpenApiResponseOk":{"description":"API specification in OpenAPI 3 format","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/x-yaml":{"schema":{"type":"string"}},"text/x-yaml":{"schema":{"type":"string"}}}},"RoutesResponseOk":{"description":"Routes API response in case of success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RouterRouteResponse"},"examples":{"routeResponseExample":{"$ref":"#/components/examples/routeResponseExample"},"evRouteResponseExample":{"$ref":"#/components/examples/evRouteResponseExample"}}}},"headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}}},"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/Routing403ErrorResponseSchema"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/403RoutingErrorResponseExample"}}}}},"Routing429ErrorResponse":{"description":"Service is rate-limited.","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/Routing429ErrorResponseSchema"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/429RoutingErrorResponseExample"}}}}},"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"},"examples":{"versionResponseOkExample":{"$ref":"#/components/examples/VersionResponseOkExample"}}}}}},"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"}},"429RoutingErrorResponseExample":{"value":{"title":"Too many requests","status":429,"code":"E605501","cause":"","action":"","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":""}},"ReroutingExample":{"value":{"mode":"returnToRoute","lastTraveledSectionIndex":0,"traveledDistanceOnLastSection":142}},"VersionResponseOkExample":{"value":[{"apiVersion":"8.18.0"},{"serviceVersion":"2022-12-15-b706cc8c-9057409"},{"dataVersions":[{"name":"traffic-feed","version":"2023-01-31T14:41:36+00:00"},{"name":"hrn:here:data::olp-here:rib-2","version":"4898"},{"name":"hrn:here:data::olp-here:here-map-content-japan-2","version":"65"},{"name":"optimized-map-for-routing","version":"2022.346.5.48"}]}]},"calculateRoutesPostAvoidExample":{"value":{"avoid":{"segments":["here:cm:segment:85925921","here:cm:segment:79445268"],"areas":[{"type":"polygon","outer":[{"lat":52.514414,"lng":13.384685},{"lat":52.514414,"lng":13.393568},{"lat":52.512403,"lng":13.393568},{"lat":52.512403,"lng":13.384685}]},{"type":"encodedPolygon","outer":"BG8mnlkD6-9wZAmrR19DAAlrR"},{"type":"boundingBox","west":1.1,"south":2.2,"east":3.3,"north":4.4,"exceptions":[{"type":"polygon","outer":[{"lat":52.514414,"lng":13.384685},{"lat":52.514414,"lng":13.393568},{"lat":52.512403,"lng":13.393568},{"lat":52.512403,"lng":13.384685}]},{"type":"encodedPolygon","outer":"BG8mnlkD6-9wZAmrR19DAAlrR"},{"type":"polygon","outer":[{"lat":52.514414,"lng":13.384685},{"lat":52.514414,"lng":13.393568},{"lat":52.512403,"lng":13.393568},{"lat":52.512403,"lng":13.384685}]}]},{"type":"encodedPolygon","outer":"BG8mnlkD6-9wZAmrR19DAAlrR","exceptions":[{"type":"corridor","polyline":[{"lat":52.514414,"lng":13.384685},{"lat":52.514414,"lng":13.393568},{"lat":52.512403,"lng":13.393568},{"lat":52.512403,"lng":13.384685}],"radius":10},{"type":"encodedCorridor","polyline":"BG8mnlkD6-9wZAmrR19DAAlrR","radius":15}]}]}}},"calculateRoutesPostEvExample":{"value":{"ev":{"preferredBrands":["6e1a148e8ddf06f613599134197b7c1c","6211c90a063d36429b599dda79ae85e3"]}}},"calculateRoutesPostExcludeExample":{"value":{"exclude":{"areas":[{"type":"polygon","outer":[{"lat":52.514414,"lng":13.384685},{"lat":52.514414,"lng":13.393568},{"lat":52.512403,"lng":13.393568},{"lat":52.512403,"lng":13.384685}]},{"type":"corridor","polyline":[{"lat":52.514414,"lng":13.384685},{"lat":52.514414,"lng":13.393568},{"lat":52.512403,"lng":13.393568},{"lat":52.512403,"lng":13.384685}],"radius":30},{"type":"encodedPolygon","outer":"BG8mnlkD6-9wZAmrR19DAAlrR"},{"type":"boundingBox","west":1.1,"south":2.2,"east":3.3,"north":4.4,"exceptions":[{"type":"polygon","outer":[{"lat":52.514414,"lng":13.384685},{"lat":52.514414,"lng":13.393568},{"lat":52.512403,"lng":13.393568},{"lat":52.512403,"lng":13.384685}]},{"type":"encodedPolygon","outer":"BG8mnlkD6-9wZAmrR19DAAlrR"},{"type":"polygon","outer":[{"lat":52.514414,"lng":13.384685},{"lat":52.514414,"lng":13.393568},{"lat":52.512403,"lng":13.393568},{"lat":52.512403,"lng":13.384685}]}]},{"type":"encodedPolygon","outer":"BG8mnlkD6-9wZAmrR19DAAlrR","exceptions":[{"type":"corridor","polyline":[{"lat":52.514414,"lng":13.384685},{"lat":52.514414,"lng":13.393568},{"lat":52.512403,"lng":13.393568},{"lat":52.512403,"lng":13.384685}],"radius":10},{"type":"encodedCorridor","polyline":"BG8mnlkD6-9wZAmrR19DAAlrR","radius":15}]}]}}},"calculateRoutesPostMaxSpeedOnSegmentExample":{"value":{"maxSpeedOnSegment":[{"segment":"here:cm:segment:207551710#+","speed":10},{"segment":"here:cm:segment:76771992","speed":1}]}},"calculateRoutesPostNetworkRestrictedTruckExample":{"value":{"networkRestrictedTruck":{"permittedNetworks":[{"country":"NZL","networks":["hpmv","fiftyMax"]},{"country":"AUS","states":["NSW"],"networks":["bDouble23Hml","bTripleGml"]},{"country":"AUS","states":["NSW","QLD"],"networks":["pbs3A"]},{"country":"AUS","states":["NSW","VIC"],"networks":["bDouble23Gml","bDouble26Hml","pbs2A"]}]}}},"evRouteResponseExample":{"value":{"routes":[{"id":"a4ba8e3d-1c48-4850-a5c9-bc9d89e88e4f","sections":[{"id":"a40f342e-c60c-4236-8294-449d75bf070d","type":"vehicle","postActions":[{"action":"chargingSetup","duration":300},{"action":"charging","duration":105,"consumablePower":150,"arrivalCharge":5.4335,"targetCharge":9.365}],"departure":{"time":"2023-09-27T14:38:19+02:00","place":{"type":"place","location":{"lat":52.5271737,"lng":13.3865749,"elv":75},"originalLocation":{"lat":52.527211,"lng":13.3865009},"displayLocation":{"lat":52.5271737,"lng":13.3865749}},"charge":7},"arrival":{"time":"2023-09-27T14:44:44+02:00","place":{"type":"chargingStation","location":{"lat":52.5364614,"lng":13.4065972,"elv":93},"displayLocation":{"lat":52.5364614,"lng":13.4065972},"id":"276u33dc5fquu-aGVyZS1ldjplY29tb3ZlbWVudDo5MjMzMTE2Mjg","name":"Allego DEALLEGO003423","attributes":{"power":150,"current":400,"voltage":375,"supplyType":"dc","connectorType":"iec62196Type2Combo"},"brand":{"hrn":"33f356bd26936af938cc8846bedc95f0","name":"Allego"},"chargePointOperator":{"id":"1f0a8b4e-cca5-11ed-a5c2-42010aa40002","name":"Allego"},"matchingEMobilityServiceProviders":[{"id":"1f098f1e-cca5-11ed-b774-42010aa40002","name":"Last Mile Solutions"},{"id":"1f39ad02-cca5-11ed-9d1a-42010aa40002","name":"Shell Recharge"},{"id":"1f351b84-cca5-11ed-8155-42010aa40002","name":"Plugsurfing"}]},"charge":5.4335},"transport":{"mode":"car"}}]}]}},"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":"violatedVehicleRestriction","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 that apply to 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,"currentWeight":2530},"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"}}]}]}},"routeResponseManeuverSignpostInfoExample":{"value":{"labels":[{"name":{"value":"San Jose","language":"en"},"routeNumber":{"value":"US-101","language":"en","direction":"south"}},{"name":{"value":"San Francisco","language":"en"},"routeNumber":{"value":"US-101","language":"en","direction":"north"}},{"routeNumber":{"value":"I-280","language":"en"}}]}},"routeResponseNoticeExample":{"value":{"title":"Route calculation failed: Couldn't match origin.","code":"couldNotMatchOrigin","severity":"critical"}}}}}