{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"http://fleet.ls.hereapi.com","description":"Generated server url"}],"tags":[{"name":"Map Attributes","description":"The HERE Map Attributes API offes simple and fast access to the rich HERE Map Content, seamlessly extensible by your own map data"},{"name":"Route Matching V8","description":"Match GPS traces onto the most probably driven path"},{"name":"Geofencing V8","description":"The HERE Geofencing API can geofence asset positions against HERE Map objects or custom fence objects"},{"name":"Map Attributes V8","description":"The HERE Map Attributes API offers simple and fast access to the rich HERE Map Content, seamlessly extensible by your own map data"},{"name":"Map Attributes V8","description":"Upload custom roads/restrictions and custom POIs"},{"name":"Search","description":"Retrieve map features & custom features"},{"name":"Waypoints Sequence","description":"Compute best Sequence for Waypoints (Travelling Salesman Problem)"},{"name":"Upload Data","description":"Upload custom roads/restrictions and custom POIs"},{"name":"Routing Extensions & Route Matching","description":"Route calculation with enterprise features"}],"paths":{"/v8/maps/overlays/upload":{"get":{"tags":["Route Matching V8"],"summary":"Submit an overlay map for customized route matching.- Deprecated","description":"Submit an overlay map with custom modifications, such as block road links, remove restrictions from road links, or insert new road links into the network. The modifications that you submit, as part of your overlay maps, are only visible to you but not to other customers. Also, these modifications are not uploaded to the official HERE map. Route matching can consider overlay maps. Note: This feature is deprecated.","operationId":"overlayUploadV8","parameters":[{"name":"overlay_spec","in":"query","description":"mandatory (unless in POST body). string. JSON structure describing the map changes.","required":true,"schema":{"type":"string"}},{"name":"point_order_obeys_one_ways","in":"query","description":"optional. true/false. If true then geometry is not matched onto links if it is against the legal driving direction.","required":false,"schema":{"type":"boolean"}},{"name":"multidigitized_handling","in":"query","description":"optional. If ACCESS specified then access restrictions of the overlay get applied into both driving direction. Per default they are applied into the direction of the order of points given. Can also be specified per overlay operation (parameter multidigitizedHandling)","required":false,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"storage","in":"query","description":"optional. string. Currently only readonly is supported.","required":false,"schema":{"type":"string","default":"readonly"}},{"name":"map_name","in":"query","description":"Mandatory. String. Overlay map name, and layer name within this map. Case insensitive. Must start with OVERLAY and contain only characters. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json.","required":false,"schema":{"type":"string"}},{"name":"private_link_handling","in":"query","description":"optional. string. Three values are supported: PLAIN = normal behavior (default), UNCONNECTED = don't connect new links to existing private links (use to avoid connecting new links to an unrelated neighboring facility), DROPEXISTING = block the existing private links (use if an existing link overlaps with a new link and is less","required":false,"schema":{"type":"string"}},{"name":"max_distance_to_match","in":"query","description":"optional. number. Specifies how many meters apart the geometries of two new links can be, to establish a connection. Should not exceed a few meters.","required":false,"schema":{"type":"string"}},{"name":"max_distance_to_connect","in":"query","description":"optional. number. Specifies how many meters apart the geometries of a new link and an existing link can be, to establish connection. Should not exceed a few meters.","required":false,"schema":{"type":"string"}},{"name":"min_match_confidence","in":"query","description":"optional, default 0.6. 0.0 ... 1.0. Specify the minimum required road match confidence level. If a match is below this level, the service throws an error.","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"optional. string. Specifies the name of a user-defined function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"fullTable","in":"query","description":"optional, default 'true'. Set to 'false' if the layer upload response time is too big otherwise. If 'false' then /search/all.json will not work on this layer.","required":false,"schema":{"type":"string","default":"true"}},{"name":"max_match_search_distance","in":"query","description":"optional. number. Default 100 meter. Specifies how many meters around a given point to search for existing geometries. Should not exceed a few meters.","required":false,"schema":{"type":"string"}},{"name":"matchMode","in":"query","description":"optional. 0 or 1. Default 0. 0 does sophisticated geometry match. 1 does a quicker check which is usually sufficient if the geometries fit exactly to the existing road network.","required":false,"schema":{"type":"string"}},{"name":"parent_overlay","in":"query","description":"optional. Overlay map name to be used as a base on top of whch to apply this overlay submission.","required":false,"schema":{"type":"string"}},{"name":"id_space_offset","in":"query","required":false,"schema":{"type":"string"}},{"name":"granted_app_ids","in":"query","description":"Comma separated list of app_ids which also have (per default read+export) access to this layer (specifying ownerAppId.mapName.layerName). Example &granted_app_ids=otherAppId1,otherAppId2","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverlaySubmitResponse"}}}}}},"post":{"tags":["Route Matching V8"],"summary":"Submit an overlay map for customized route matching.- Deprecated","description":"Submit an overlay map with custom modifications, such as block road links, remove restrictions from road links, or insert new road links into the network. The modifications that you submit, as part of your overlay maps, are only visible to you but not to other customers. Also, these modifications are not uploaded to the official HERE map. Route matching can consider overlay maps. Note: This feature is deprecated.","operationId":"overlayUploadV8_1","parameters":[{"name":"overlay_spec","in":"query","description":"mandatory (unless in POST body). string. JSON structure describing the map changes.","required":true,"schema":{"type":"string"}},{"name":"point_order_obeys_one_ways","in":"query","description":"optional. true/false. If true then geometry is not matched onto links if it is against the legal driving direction.","required":false,"schema":{"type":"boolean"}},{"name":"multidigitized_handling","in":"query","description":"optional. If ACCESS specified then access restrictions of the overlay get applied into both driving direction. Per default they are applied into the direction of the order of points given. Can also be specified per overlay operation (parameter multidigitizedHandling)","required":false,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"storage","in":"query","description":"optional. string. Currently only readonly is supported.","required":false,"schema":{"type":"string","default":"readonly"}},{"name":"map_name","in":"query","description":"Mandatory. String. Overlay map name, and layer name within this map. Case insensitive. Must start with OVERLAY and contain only characters. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json.","required":false,"schema":{"type":"string"}},{"name":"private_link_handling","in":"query","description":"optional. string. Three values are supported: PLAIN = normal behavior (default), UNCONNECTED = don't connect new links to existing private links (use to avoid connecting new links to an unrelated neighboring facility), DROPEXISTING = block the existing private links (use if an existing link overlaps with a new link and is less","required":false,"schema":{"type":"string"}},{"name":"max_distance_to_match","in":"query","description":"optional. number. Specifies how many meters apart the geometries of two new links can be, to establish a connection. Should not exceed a few meters.","required":false,"schema":{"type":"string"}},{"name":"max_distance_to_connect","in":"query","description":"optional. number. Specifies how many meters apart the geometries of a new link and an existing link can be, to establish connection. Should not exceed a few meters.","required":false,"schema":{"type":"string"}},{"name":"min_match_confidence","in":"query","description":"optional, default 0.6. 0.0 ... 1.0. Specify the minimum required road match confidence level. If a match is below this level, the service throws an error.","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"optional. string. Specifies the name of a user-defined function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"fullTable","in":"query","description":"optional, default 'true'. Set to 'false' if the layer upload response time is too big otherwise. If 'false' then /search/all.json will not work on this layer.","required":false,"schema":{"type":"string","default":"true"}},{"name":"max_match_search_distance","in":"query","description":"optional. number. Default 100 meter. Specifies how many meters around a given point to search for existing geometries. Should not exceed a few meters.","required":false,"schema":{"type":"string"}},{"name":"matchMode","in":"query","description":"optional. 0 or 1. Default 0. 0 does sophisticated geometry match. 1 does a quicker check which is usually sufficient if the geometries fit exactly to the existing road network.","required":false,"schema":{"type":"string"}},{"name":"parent_overlay","in":"query","description":"optional. Overlay map name to be used as a base on top of whch to apply this overlay submission.","required":false,"schema":{"type":"string"}},{"name":"id_space_offset","in":"query","required":false,"schema":{"type":"string"}},{"name":"granted_app_ids","in":"query","description":"Comma separated list of app_ids which also have (per default read+export) access to this layer (specifying ownerAppId.mapName.layerName). Example &granted_app_ids=otherAppId1,otherAppId2","required":false,"schema":{"type":"string"}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverlaySubmitResponse"}}}}}}},"/2/overlays/upload.json":{"get":{"tags":["Upload Data"],"summary":"Submit an overlay map for customized routing.","description":"Submit an overlay map with custom modifications, such as block road links, remove restrictions from road links, or insert new road links into the network. The modifications that you submit, as part of your overlay maps, are only visible to you but not to other customers. Also, these modifications are not uploaded to the official HERE map. Routing can consider overlay maps.","operationId":"upload_json","parameters":[{"name":"overlay_spec","in":"query","description":"mandatory (unless in POST body). string. JSON structure describing the map changes.","required":true,"schema":{"type":"string"}},{"name":"point_order_obeys_one_ways","in":"query","description":"optional. true/false. If true then geometry is not matched onto links if it is against the legal driving direction.","required":false,"schema":{"type":"boolean"}},{"name":"multidigitized_handling","in":"query","description":"optional. If ACCESS specified then access restrictions of the overlay get applied into both driving direction. Per default they are applied into the direction of the order of points given. Can also be specified per overlay operation (parameter multidigitizedHandling)","required":false,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"storage","in":"query","description":"optional. string. Currently only readonly is supported.","required":false,"schema":{"type":"string","default":"readonly"}},{"name":"map_name","in":"query","description":"Mandatory. String. Overlay map name, and layer name within this map. Case insensitive. Must start with OVERLAY and contain only characters. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json.","required":false,"schema":{"type":"string"}},{"name":"private_link_handling","in":"query","description":"optional. string. Three values are supported: PLAIN = normal behavior (default), UNCONNECTED = don't connect new links to existing private links (use to avoid connecting new links to an unrelated neighboring facility), DROPEXISTING = block the existing private links (use if an existing link overlaps with a new link and is less","required":false,"schema":{"type":"string"}},{"name":"max_distance_to_match","in":"query","description":"optional. number. Specifies how many meters apart the geometries of two new links can be, to establish a connection. Should not exceed a few meters.","required":false,"schema":{"type":"string"}},{"name":"max_distance_to_connect","in":"query","description":"optional. number. Specifies how many meters apart the geometries of a new link and an existing link can be, to establish connection. Should not exceed a few meters.","required":false,"schema":{"type":"string"}},{"name":"min_match_confidence","in":"query","description":"optional, default 0.6. 0.0 ... 1.0. Specify the minimum required road match confidence level. If a match is below this level, the service throws an error.","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"optional. string. Specifies the name of a user-defined function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"fullTable","in":"query","description":"optional, default 'true'. Set to 'false' if the layer upload response time is too big otherwise. If 'false' then /search/all.json will not work on this layer.","required":false,"schema":{"type":"string","default":"true"}},{"name":"max_match_search_distance","in":"query","description":"optional. number. Default 100 meter. Specifies how many meters around a given point to search for existing geometries. Should not exceed a few meters.","required":false,"schema":{"type":"string"}},{"name":"matchMode","in":"query","description":"optional. 0 or 1. Default 0. 0 does sophisticated geometry match. 1 does a quicker check which is usually sufficient if the geometries fit exactly to the existing road network.","required":false,"schema":{"type":"string"}},{"name":"parent_overlay","in":"query","description":"optional. Overlay map name to be used as a base on top of whch to apply this overlay submission.","required":false,"schema":{"type":"string"}},{"name":"id_space_offset","in":"query","required":false,"schema":{"type":"string"}},{"name":"granted_app_ids","in":"query","description":"Comma separated list of app_ids which also have (per default read+export) access to this layer (specifying ownerAppId.mapName.layerName). Example &granted_app_ids=otherAppId1,otherAppId2","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverlaySubmitResponse"}}}}}},"post":{"tags":["Upload Data"],"summary":"Submit an overlay map for customized routing.","description":"Submit an overlay map with custom modifications, such as block road links, remove restrictions from road links, or insert new road links into the network. The modifications that you submit, as part of your overlay maps, are only visible to you but not to other customers. Also, these modifications are not uploaded to the official HERE map. Routing can consider overlay maps.","operationId":"upload_json_1","parameters":[{"name":"overlay_spec","in":"query","description":"mandatory (unless in POST body). string. JSON structure describing the map changes.","required":true,"schema":{"type":"string"}},{"name":"point_order_obeys_one_ways","in":"query","description":"optional. true/false. If true then geometry is not matched onto links if it is against the legal driving direction.","required":false,"schema":{"type":"boolean"}},{"name":"multidigitized_handling","in":"query","description":"optional. If ACCESS specified then access restrictions of the overlay get applied into both driving direction. Per default they are applied into the direction of the order of points given. Can also be specified per overlay operation (parameter multidigitizedHandling)","required":false,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"storage","in":"query","description":"optional. string. Currently only readonly is supported.","required":false,"schema":{"type":"string","default":"readonly"}},{"name":"map_name","in":"query","description":"Mandatory. String. Overlay map name, and layer name within this map. Case insensitive. Must start with OVERLAY and contain only characters. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json.","required":false,"schema":{"type":"string"}},{"name":"private_link_handling","in":"query","description":"optional. string. Three values are supported: PLAIN = normal behavior (default), UNCONNECTED = don't connect new links to existing private links (use to avoid connecting new links to an unrelated neighboring facility), DROPEXISTING = block the existing private links (use if an existing link overlaps with a new link and is less","required":false,"schema":{"type":"string"}},{"name":"max_distance_to_match","in":"query","description":"optional. number. Specifies how many meters apart the geometries of two new links can be, to establish a connection. Should not exceed a few meters.","required":false,"schema":{"type":"string"}},{"name":"max_distance_to_connect","in":"query","description":"optional. number. Specifies how many meters apart the geometries of a new link and an existing link can be, to establish connection. Should not exceed a few meters.","required":false,"schema":{"type":"string"}},{"name":"min_match_confidence","in":"query","description":"optional, default 0.6. 0.0 ... 1.0. Specify the minimum required road match confidence level. If a match is below this level, the service throws an error.","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"optional. string. Specifies the name of a user-defined function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"fullTable","in":"query","description":"optional, default 'true'. Set to 'false' if the layer upload response time is too big otherwise. If 'false' then /search/all.json will not work on this layer.","required":false,"schema":{"type":"string","default":"true"}},{"name":"max_match_search_distance","in":"query","description":"optional. number. Default 100 meter. Specifies how many meters around a given point to search for existing geometries. Should not exceed a few meters.","required":false,"schema":{"type":"string"}},{"name":"matchMode","in":"query","description":"optional. 0 or 1. Default 0. 0 does sophisticated geometry match. 1 does a quicker check which is usually sufficient if the geometries fit exactly to the existing road network.","required":false,"schema":{"type":"string"}},{"name":"parent_overlay","in":"query","description":"optional. Overlay map name to be used as a base on top of whch to apply this overlay submission.","required":false,"schema":{"type":"string"}},{"name":"id_space_offset","in":"query","required":false,"schema":{"type":"string"}},{"name":"granted_app_ids","in":"query","description":"Comma separated list of app_ids which also have (per default read+export) access to this layer (specifying ownerAppId.mapName.layerName). Example &granted_app_ids=otherAppId1,otherAppId2","required":false,"schema":{"type":"string"}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverlaySubmitResponse"}}}}}}},"/v8/match/routelinks":{"get":{"tags":["Route Matching V8"],"summary":"Match GPS traces to get the most probably driven path. Use &routeMatch=1 for default route matching behavior. Compatible with version 2 route matching.","operationId":"matchRouteV8compatibilityToV2","parameters":[{"name":"driver_cost","in":"query","description":"Cost per hour in target currency.","required":false,"schema":{"type":"string"}},{"name":"vehicle_cost","in":"query","description":"Cost per kilometer in target currency.","required":false,"schema":{"type":"string"}},{"name":"vehicleCostOnFerry","in":"query","description":"Cost per kilometer on ferry in target currency. Default = vehicle_cost.","required":false,"schema":{"type":"string"}},{"name":"currency","in":"query","description":"3 letter ISO currency symbol. Required if toll cost must be added up across different currencies and/or be added to driver/vehicle/fuel cost in different currencies.","required":false,"schema":{"type":"string"},"example":"USD"},{"name":"departure","in":"query","description":"Format: now, yyyy-MM-dd'T'HH:mm:ss or yyyy-MM-dd'T'HH:mm:ssX. If no timezone is specified, then the local timezone at the route start link is used. Default: Ignore all time dependent access restrictions. Special values: ignoreTimeDepRestr (like default), obeyTimeDepRestr (all time dependent restrictions apply).","required":false,"schema":{"type":"string"}},{"name":"tollVehicleType","in":"query","description":"Vehicle type for toll calculation, use only if toll should also be estimated for the matched route. Possible values: 1=Motorcycle, 2=Auto, 3=Truck, 4=Motor home, 5=Minibus, 6=Bus, 7=Motorcycle Sidecar(EU), 8=Tricycle(EU), 9=Delivery Truck(EU+India), 10=Snowmobile(US), 11=Pick-up(US+India), 12=Tractor(US+India), 13=Taxi, 14=HCM/EME (India Heavy Construction Machinery/Earth Moving Equipment)","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","description":"0=None, 1=Caravan, 2=Trailer, 3=RVTrailer, 4=BoatTrailer. For toll cost and recreational vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","description":"Number of trailers, 0...4. For toll cost and truck restrictions. 0=no trailer, 1=one or more trailers, 2=two or more trailers, 3=three or more trailers. For truck restrictions: 4=one or more semi-trailers.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","description":"Number of axles excluding trailers. For toll cost and for country wide truck restrictions.
","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","description":"Number of trailer axles. For toll cost and for country wide truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","description":"1=fuel+electric, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","description":"1=EURO I, 2=EURO II, 3=EURO III, 4=EURO IV, 5=EURO V, 6=EURO VI, 7=EURO EEV, 8=Electric Vehicles, 9=EURO II with PRC, 10=EURO III with PRC. For toll cost and environmental zone restrictions, when emissionType is not specified it defaults to 5.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","description":"CO2 emission class of the vehicle. 1=Emission class 1, 2=Emission class 2, 3=Emission class 3, 4=Emission class 4, 5=Emission class 5. For toll cost only, when co2EmissionClass is not specified then it defaults to 1. Providing invalid combination of emissionType and co2EmissionClass in request may result in incorrect toll costs.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","description":"Actual height of the overall rigid/semi truck including trailers: 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","description":"Actual height of the trailer(s). 350cm or 3.5m or 138in. For toll cost only, not considered for route path creation (use height parameter)
(Not available for Waypoints Sequence).","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","description":"Actual total weight of vehicle incl. payload, but not trailers' weight or payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","description":"Actual total weight of vehicle incl. payload and trailers/caravan incl. their payload. 7.5t or 7500kg or 16500lbs. For truck restrictions, speed profile, toll cost and environmental zone restrictions. See also vehicleWeight. Note that country wide weight restrictions depend on the number of axles and trailers as well, so it might be necessary to specify them as well.","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Legal maximum weight limit of vehicle incl. payload and trailers. Also incl. their payload as a total. 7.5t or 7500kg or 16500lbs. For truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","description":"1=vehicle equipped to carry disabled people, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","description":"Actual number of passengers. For toll cost. See also vehicle type carHOV.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","description":"Number of tires. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","description":"1=vehicle registered for commercial use, 0=otherwise. For toll cost, environmental zone regulations and delivery-only zones.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","description":"Comma separated list from explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable. For toll cost (only explosive and other) and for truck restrictions. For Waypoints Sequence, allhazardousGoods and explosiveFlammable are not supported.","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","description":"350cm or 3.5m or 138in. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","description":"Length of the vehicle (including potential trailers). 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxle","in":"query","description":"Actual total weight per axle, incl. payload. 7.5t or 7500kg or 16500lbs (Waypoints Sequence in kg, no unit). For toll cost and truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"width","in":"query","description":"Width of the vehicle, e.g. 350cm or 3.5m or 138in. For truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"tunnelCategory","in":"query","description":"Defines the tunnel categories the truck must NOT use. B, C, D or E. A tunnels have no restrictions. E tunnels have most restrictions. If C is defined, the route will use A and B tunnels but not C, D or E.","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","description":"Defines the fuel powering the vehicle. Can be Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric. (LPG=Liquefied Petroleum Gas, LNG=Liquefied Natural Gas). Used f.e. for environmental zone restrictions, toll cost calculation, consumption based routing for Electric vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"weightPerAxleGroup","in":"query","description":"Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported names are drive, single, tandem, triple, quad, quint. Example: &weightPerAxleGroup=drive:12;single:11;tandem:18
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailerWeight","in":"query","description":"Actual total weight of trailers with their payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.","required":false,"schema":{"type":"string"}},{"name":"overlays","in":"query","description":"Overlay map name. Case insensitive. Must start with OVERLAY and contain only characters.","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"Semicolon separated list of the route type, vehicle type, traffic options and additional optional parameters. As optional parameters, following avoid road types can be specified (semicolon separated by avoid level) - motorway 0, -1, -2, -3), tollroad (0, -1, -2, -3), boatFerry (0, -1, -2, -3), railFerry (0, -1, -2, -3), and tunnel (0, -1, -2, -3). Format - shortest|fastest;vehicletype;traffic:enabled|disabled|default;motorway:0|-1|-2|-3;tollroad:0|-1|-2|-3;boatFerry:0|-1|-2|-3;railFerry:0|-1|-2|-3;tunnel:0|-1|-2|-3. Vehicle types supported: bdouble, bicycle, bus, car, carHOV, custom1, emergency, motorcycle, pedestrian, roadtrain, taxi, truck. \"shortest\" and \"balanced\" are not supported but can be individually tuned using &driver_cost and &vehicle_cost. ","required":false,"schema":{"type":"string"}},{"name":"restTimes","in":"query","description":"Parameter to enable driver rest time calculations based on legal drive/rest intervals. Specify 'local' to obey the legal driver rest times of the respective country. Alternatively, proprietary values can be set for DriveTimeUntilShortBreak, ElapsedTimeUntilShortBreak, ShortBreakDuration, DriveTimeUntilLongRest, ElapsedTimeUntilLongBreak, LongRestDuration. E.g. EU requires after 4.5h a 45min break + after 9h an 11h rest. If the driver is not fresh then add ,TimeAlreadyDrivenSinceLastShortBreak, ElapsedTimeSinceLastShortBreak, TimeAlreadyDrivenSinceLastLongRest, ElapsedTimeSinceLastLongRest in seconds. Specify ;earlierRestTimeFactor:0.0 to take rest times much earlier to reduce travel time (arriving with less legal driving time left), default = 0.75","required":false,"schema":{"type":"string"}},{"name":"language","in":"query","description":"Language for the maneuver instructions in the response. Currently de-de, en-us, it-it, fr-fr, es-es, pt-pt, pl-pl, zh-cn, zh-tw, zh-hk and ja-jp are supported. If not specified, en-us is used.","required":false,"schema":{"type":"string"}},{"name":"avoidLinks","in":"query","description":"Comma separated list of link ids or lat,lon[;heading] coordinates to be avoided. Positive ids are not driven from reference node, negative ids are not driven towards reference node. Use '*' prefix to avoid both directions. For coordinates direction of blocking depends on the heading. If no heading given both directions will be avoided. Optionally an entry penalty (applied once while entering the sequence of link(s)) and drive penalty (applied to every link) can be specified individually for each link to be avoided, format: 'linkId[;penalty:entryPenaltySec[:drivePenaltyFactor]] or lat,lon[;penalty:entryPenaltySec[:drivePenaltyFactor]]'. entryPenalty should be between -120 and 600 (-ve penalty implies prefer), drivePenaltyFactor should be between 0.1 and 20.0 (1.0 implies no penalty, < 1.0 implies prefer). e.g. 1308094486;penalty:60:1.5,-1308094485;penalty:2:2.5 .","required":false,"schema":{"type":"string"}},{"name":"avoidAreas","in":"query","description":"List of areas (rectangles or polygons) to be avoided. Areas are separated by '!'. Rectangles can be specified with two diagonal coordinates separated by ';', e.g. latMax,lonMin;latMin,lonMax. Polygons are specified with consecutive vertex coordinates separated by ';', e.g. lat1,lon1;lat2,lon2;lat3,lon3;... ","required":false,"schema":{"type":"string"}},{"name":"arrival","in":"query","description":"Format like departure. Use this to find out when you have to start the journey to arrive at the given time. Note that toll cost is not considered when arrival time is specified.","required":false,"schema":{"type":"string"},"example":"2022-11-16T12:54:14+10"},{"name":"rollups","in":"query","description":"Comma separated list of rollups (groupings, aggregation levels) for the toll cost response. Currently supported values are: none (toll cost details per link), total (overall total toll cost only), tollsys (toll cost summary per toll system), country (summary per country), country;tollsys (summary per country and toll system). Example: &rollups=none,country;tollsys,country returns the individual linl level cost details and 2 different summaries.","required":false,"schema":{"type":"string"}},{"name":"tollPass","in":"query","description":"Comma separated list of owned passes for toll cost calculation. Supported values: Senior_Pass, transponder (meaning the car has all transponders), allPasses, Annual, Nr_of_Days, Nr_of_Months (meaning the car has all passes valid for this number of months), AutoPass, SunPass, E-Z Pass (last 2 are examples for real toll transponders). Can also list toll system ids or toll booth condition ids. Allows traversal of 'transponder-only' toll booths, allows cost free traversal of certain toll sections and allows using cheaper prices for transponder/pass owners.","required":false,"schema":{"type":"string"}},{"name":"speedFcCat","in":"query","description":"Comma separated list of speeds driven in kilometer per hour per road functional class (1-5 + Virtual Connections VC) and speed category (1-8) (f.e. FC1-SC1,FC1-SC2,...,FC1-SC8;FC2-SC1,FC2-SC2,...;...;VC-SC1,FC-SC2,...VC-SC8). Functional classes are semicolon separated. Can contain empty entries (no change to default f.e. 80,76,,,,,,;,,,54,46,,,;...). Overrides router's default driven speed values. Also one of the predefined profiles can be activated by value car, light-truck, medium-truck or heavy-truck","required":false,"schema":{"type":"string"}},{"name":"routeAttributes","in":"query","description":"Defines which information is included in the response route part of the calculated route. Defaults to mode (mo), waypoints (wp), summary (sm), flags (fl). Also supported: speedProfile (sp), shape (sh), summaryByCountry (sc), boundingBox (bb), none. Can be excluded in the response by putting a hyphen in the front. e.g. -wp","required":false,"schema":{"type":"string"}},{"name":"responseAttributes","in":"query","description":"Defines which information is included in the response as part of the calculated route. Defaults to warnings (wn). Also supported: language (lg), polyline(polyline), summary(summary), actions(actions), routehandle(routehandle), turnbyturnactions(turnbyturnactions), none. Can be excluded in the response by putting a hyphen in the front. e.g. -wn","required":false,"schema":{"type":"string"}},{"name":"metaAttributes","in":"query","description":"Defines which information is included in the meta part of the calculated route. Defaults to none. Also supported: version (ver). Can be excluded in the response by putting a hyphen in the front. e.g. -ver","required":false,"schema":{"type":"string"}},{"name":"maneuverAttributes","in":"query","description":"Defines which information is included in the response as part of the data representation of the route maneuvers. Defaults to position (po), length (le), travelTime (tt). Also supported: direction (di), action (ac), indices (ix), lanes (ln), roadName(rn), nextRoadName (nr), beforeAfter (ba) and none.","required":false,"schema":{"type":"string"}},{"name":"legAttributes","in":"query","description":"Defines which information is included in the response as part of the route legs. Defaults to links (li), maneuvers (mn), length (le), travelTime (tt), baseTime (bt), trafficTime (tm). Also supported: shape (sh), boundingBox (bb), turnbyturnmaneuvers (mm), none. Can be excluded in the response by putting a hyphen in the front. e.g. -mn. Also in RouteMatch mode legAttributes=mn is supported.","required":false,"schema":{"type":"string"}},{"name":"linkAttributes","in":"query","description":"Define optional attributes to be returned for each link. Defaults to shape (sh), length (le), remainTime (rt), remainDistance (rd), functionalClass (fc), warnings (wn), confidence (cd), segmentRef (sr). Also supported: cost (co), maneuver (ma), timezone (tz), none. Can be excluded in the response by putting a hyphen in the front. e.g. -ma","required":false,"schema":{"type":"string"}},{"name":"traverseGates","in":"query","description":"Assume the driver has keys/permissions to traverse gates, if \"true\". Accepted values are either \"true\" or \"airlineDistanceInMeters,entryPenaltyInSec\". Accepted values are either \"true\" or \"airlineDistanceInMeters,entryPenaltyInSec\". Default = don't traverse any gates unless vehicle type is emergency.","required":false,"schema":{"type":"string"}},{"name":"routeMatch","in":"query","description":"Parameter to chose the operational mode of the Route Matching algorithm, supported values are 0|1|2. Default mode if not specified is 0 - Computes a legal route that goes through all way points. 1 - Route Matching mode, treats the waypoints (or trace file POST body) as a GPS trace and return the most probable matched route along this trace. 2 - ETA Tracking mode, computes the route based on waypoints specified, in addition, it uses the POST body GPS trace to detect any taken driver rest times/break and reached/skipped waypoints. To get maneuvers for a matched route specify &legAttributes=mn.","required":false,"schema":{"type":"string"}},{"name":"legal","in":"query","description":"For mode routeMatch=1. Enforces a legal route w.r.t. the following route condition types (comma separated list): access,gate,oneway,thrutraf,turn. Passing all of them yields a legal route as from a router. access - use only links allowed for the vehicle type (incl. truck measures). gate - don't traverse gates. oneway - don't drive links into forbidden direction. thrutraf - don't enter+leaving 'no through traffic' zones. turn - don't turn/u-turn illegally. Default: avoid illegal maneuvers, but use them if the trace obviously used them. If used, return respective warnings.","required":false,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"Comma separated list of Map Attributes layer names, to get additonal attributes along the route. Only link-based attribute layers (roughly those ending in _FC1, _FC2 ... ) are supported. Specify FCn to get content from specific functional class layer corresponding to the link. After each layer name, comma separated list of individual layer attributes can be listed within brackets, or specify (*) to get all layer attributes. Example: &attributes=ROAD_GEOM_FCn(TUNNEL), SPEED_LIMITS_FCn (FROM_REF_SPEED_LIMIT, TO_REF_SPEED_LIMIT), ADAS_ATTRIB_FCn (SLOPES). A maximum of 32 layers can be requested per request.","required":false,"schema":{"type":"string"},"example":"SPEED_LIMITS_FCN"},{"name":"customConsumptionDetails","in":"query","description":"Semicolon separated list of speed/ascent/descent/builtupFactor/auxilliaryConsumption fuel consumption parameters. Speed is a list of $/km for different speeds. Ascent/descent are additional $/km per altitude climbed or descended. Builtup factor is an optional heuristic consumption multiplier for urban area, default value is 1.55. auxilliaryConsumption is the additional consumption (per hour) for running auxilliary units (climate control, infotainment, lights, etc.). Cost unit is not $ but 'currency'. Example: speed,0,0.102,10,0.084,30,0.066,50,0.06,70,0.066,100,0.072,120,0.084,140,0.108; ascent,0.4; descent,0.1; builtupFactor,1.4 = at 70 kph the car consumes 6.6$/100km and 0.4$/km altitude climbed, consumption increases 40% in urban area. Alternatively, user can specify default consumption profile: 3.5t, 7.5t, 18t, 40t or weightDependent. In case of the weightDependent consumption profiles will be decided based on the limitedWeight so this parameter also needs to be specified.","required":false,"schema":{"type":"string"}},{"name":"alternatives","in":"query","description":"Only for routeMatch=0. Maximum number of alternative route options to return. Can return less or no alternatives. Only returns route alternatives that significantly differ from the best route but are not much more costly.","required":false,"schema":{"type":"string"}},{"name":"timeout","in":"query","description":"Routing calculation must be finished within this amount of milliseconds. Default 50000. Maximum 50000.","required":false,"schema":{"type":"string"}},{"name":"ignoreWaypointVehicleRestriction","in":"query","description":"Waypoint restrictions can be ignored by setting radius[;penaltyFactor[;all]]. For detailed information on this parameter and its usage, please see Dev Guide \"Concepts - Find a path despite access restrictions\".","required":false,"schema":{"type":"string"}},{"name":"maxSpeed","in":"query","description":"Maximum speed allowed for the whole route. Supported units are kmh (kilometres per hour), mph (miles per hour) and mps (metres per second). If no unit is provided, kmh will be used as default unit.","required":false,"schema":{"type":"string"}},{"name":"alignToGpsTime","in":"query","description":"Only for routeMatch=1 and 2. Route matching tries to align the driving time to the GPS timestamps in trace (if available). Supported values: 0|1. This feature is enabled by default (1), set the value 0 to disable it.","required":false,"schema":{"type":"string"}},{"name":"customAttributes","in":"query","description":"Comma separated list of Customer (BYOD) layer names, to get link attributes along the route. Format follows the 'attribute' parameter. No FCn notation supported.","required":false,"schema":{"type":"string"}},{"name":"mapMatchRadius","in":"query","description":"Maximum adaptive map match search radius [in meter] that will be applied to each waypoint. If specified it overrides waypoints' transitRadius values and the default maximum adaptive search radius. For routing (mode routeMatch=0), default value is: 1600, max limit: 5000.","required":false,"schema":{"type":"string"}},{"name":"excludeZoneTypes","in":"query","description":"Only for routeMatch=0, not supported for route matching. Specify if the route may not enter a specific zone type. Currently supported values: environmental,vignette and congestionPricing. If omitted or empty, zone restrictions are not taken into account. ","required":false,"schema":{"type":"string"}},{"name":"instructionFormat","in":"query","description":"To choose the maneuver instruction text representation format in response. Supported formats are text or html","required":false,"schema":{"type":"string"}},{"name":"oneway","in":"query","description":"Option to control oneway violation behavior, default - obey all oneways. Format - 'penalty':penaltyFactor, eg. 'penalty:0.5' - allows oneway violation if the time benefit is more than 0.5 sec/meter. For bicycle recommended value 0.125, for emergencies 0.5. Not allowed for other vehicles.","required":false,"schema":{"type":"string"}},{"name":"drivingReport","in":"query","description":"Parameter to enable the Advanced driving analytics / driving report feature, added to the route match response. Set to 1 to enable it, disabled by default.","required":false,"schema":{"type":"string"}},{"name":"ignorePreferredRoutes","in":"query","description":"Only for routeMatch=0. Preferred routes for a specific vehicle type are taken by default. To turn if off set ignorePreferredRoutes to true.","required":false,"schema":{"type":"string"}},{"name":"avoidTurns","in":"query","description":"Comma separated list of elements like left[;minAngleDegree;penaltySec] or right... or uTurn[;penaltySec] if a left/right turn is sharper than the specified angle (0...180) then the given time penalty is applied. uTurnAtWaypoint avoids u-turning on the link directly where the waypoint was reached.","required":false,"schema":{"type":"string"}},{"name":"ignoreZeroSpeedPoints","in":"query","description":"Only for routeMatch=1 and 2. Default = consider all points. 1 = ignore trace points that have zero speed (only in traces that provide speed but not time).","required":false,"schema":{"type":"string"}},{"name":"wpDist","in":"query","description":"Only for routeMatch=1 and 2. Default value = 0, feature is disabled. 1 = return spatial distance between matched trace points. 2 = return spatial distance between original trace points","required":false,"schema":{"type":"string"}},{"name":"customRestrLimit","in":"query","description":"Comma separated list of key value pairs of custom restriction limits. The key and value of individual custom restriction limit must be numeric and must be separated by colon. Example: 0:10,1:20,2:50","required":false,"schema":{"type":"string"}},{"name":"learnStopsId","in":"query","description":"Only for routeMatch=2. Identifier of a profile to learn stop characteristics. Profiles can be defined arbitrarily, e.g by driver, vehicle, departure time or a combination of them. Parameter is used to learn while route matching. Cannot be used together with learnedStopsId.","required":false,"schema":{"type":"string"}},{"name":"learnedStopsId","in":"query","description":"Only for routeMatch=2. Identifier of a already learned profile, to be used for stop characteristics. Profiles can be defined arbitrarily, e.g by driver, vehicle, departure time or a combination of them. Parameter is to apply learnings while routing. Cannot be used together with learnStopsId.","required":false,"schema":{"type":"string"}},{"name":"routeMatch2PlannedWayPointReachRadius","in":"query","description":"Only for routeMatch=2. If vehicle approaches a planned waypoint closer than this then the waypoint is considered reached. Default 20000.0m.","required":false,"schema":{"type":"string"}},{"name":"detectSkippedPlannedWaypoint","in":"query","description":"Only for routeMatch=2. Default to true. This flag enables/disables the logic to analyze the GPS trace and determines which planned waypoints are skipped. You can prevent waypoint skipping by setting this value to false.","required":false,"schema":{"type":"string"}},{"name":"plannedWaypointReachTolerance","in":"query","description":"Only for routeMatch=2 with learned stops. Default = 20000 meter. If the trace gets closer then the learned stop is considered reached","required":false,"schema":{"type":"string"}},{"name":"ignoreWaypointsFarFromNeighbors","in":"query","description":"Only for routeMatch=2. Default = true, if 'false' then algorithm does not ignore a trace point when it is much further away from its neighbors than the usual distances in the trace","required":false,"schema":{"type":"string"}},{"name":"wayPointHeadingMismatchPenaltyFactor","in":"query","description":"Tie waypoints closer to links where the GPS heading matches the link's heading, and try harder to meet waypoints in the given driving direction. Default = 1.","required":false,"schema":{"type":"string"}},{"name":"avoidPrivate","in":"query","description":"Option to use private streets for routing, routeMatch=0 and 2. Set it to '1' to always allow access to private street, '-1' to always forbid it. Default is '0' - access is allowed if there is a waypoint in the private street.","required":false,"schema":{"type":"string"}},{"name":"licensePlate","in":"query","description":"Licenseplate of the vehicle. The vehicles registration number can influence the permission to drive in certain zones, mostly environmental zones.","required":false,"schema":{"type":"string"}},{"name":"adminTruckRestrictions","in":"query","description":"By default all admin wide truck restrictions are obeyed by the algorithm. If set to 'ignore', it will ignore them.","required":false,"schema":{"type":"string"}},{"name":"mapMatchTolerance","in":"query","description":"Map match tolerance [meter]. Will be applied to each way point. Routing can meet the waypoint on all links that are that much further away from the coordinate than the nearest. Default 3.0.","required":false,"schema":{"type":"string"}},{"name":"costPerConsumptionUnit","in":"query","description":"The cost of a consumption unit in targetCurrency. Default is 1.","required":false,"schema":{"type":"string"}},{"name":"restTimeDriverCost","in":"query","description":"Cost per hour in target currency while driver is taking a legal rest time. Can be between 0 and driver_cost value.","required":false,"schema":{"type":"string"}},{"name":"avoidFeatures","in":"query","description":"Comma separated list of road features to be avoided. Currently supported: unpaved[;300;50]. Avoids unpaved roads by the specified seconds to enter (Entry penalty) and seconds/km driven (drive peanlty), or a default penalty","required":false,"schema":{"type":"string"}},{"name":"truckVerified","in":"query","description":"Only for routeMatch=0. Make use of truck verified roads for truck routing. Set to 1 to prefer transport verified roads, -1 to avoid them. Default is 0 - access is allowed, but truck verified routes are not prefered or avoided.","required":false,"schema":{"type":"string"}},{"name":"avoidCountryChange","in":"query","description":"Only for routeMatch=0. Penalties in seconds to avoid unnecessary waiting time on border crossings. Countries should be specified according to 3 character ISO 3166 standard. A comma should be used to separate the multiple avoidChangeCountry on the route. Format: Country code1-Country code2:Penalty in seconds[,Country code1-Country code2:Penalty in seconds]","required":false,"schema":{"type":"string"}},{"name":"trafficIncidents","in":"query","description":"Set to 'true' or 'false to enable/disable usage of traffic incidents for route estimation for complete length of the route, default is 'false' - traffic incidents are disabled. Usage of traffic incidents will impact the routing response time, so use only if necessary.","required":false,"schema":{"type":"string"}},{"name":"pathCoordinates","in":"query","description":"Only for routeMatch=1. Set it to '1' or '0' to enable/disable provisioning a set of coordinates to reconstruct the journey using routing. A coordinate will be collected after each junction, if a minimum distance travveled since previous. This distance is by default 50m and can be changed by the sub-parameter minDist:, but not below 25m.","required":false,"schema":{"type":"string"}},{"name":"followPath","in":"query","description":"Only for routeMatch=1. Pass a sequence of link IDs defining the route path. Syntax: F: or L:LinkID0;LinkID1;...","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","description":"Only for routeMatch=1 and 2. Trace file for route matching, accepted trace formats - GPX, NMEA, KML, CSV or AGORA-C. Please refer the documentation page 'GPS trace formats and accuracy' for detailed information on trace file formats and supported trace attributes.","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"waypoint0 ... waypointN","in":"query","description":"Comma separated waypoint latitude, longitude in WGS-84 degree. The coordinates may be directly followed by ;transitRadius;label;heading[;optional specifications]. \r\nA route must consist of at least 2 waypoints (start and destination). The coordinates may be directly followed by ;transitRadius;label;heading. \r\nThe maximum number of waypoints is limited. However, this limit is not a fixed number but is a result of the limit for the overall processing time. \r\nSet a transit radius to only influence the route to go via a certain city (Example: &waypoint1=50.12,8.65;10000). \r\nSet a heading (degree clockwise from North) to improve map matching (Example: &waypoint0=latitude,longitude;;;140). \r\nTo define a loading time or delay time at a waypoint, use stopOver[,timeInSeconds]! (Example: &waypoint1=stopOver,300!50.12,8.65). \r\nThe optional specifications altitude, custom label, !StreetPosition and !LinkPosition, ignoreRestriction are currently supported.\r\nTo define a radius around the waypoint where vehicle restrictions should be ignored use optional specification ';ignoreRestriction:radius[,drivePenalty[,type[,entryPenalty]]]. Example: &waypoint1=50.12,8.65;ignoreRestriction:8000,0.9,all,1800 . \r\nThis is similar to the global parameter 'ignoreWaypointVehicleRestriction' which applies to all waypoint. But when specified explicitly for a waypoint, the 'ignoreRestriction' specification of waypoint is applied. \r\nWaypoints can have opening and closing times, can be unsorted or optional. Details are in Key Concepts / Waypoint sorting, optional Pickup and Opening Times","required":true,"schema":{"type":"string"}},{"name":"jsonCallback","in":"query","description":"Specifies the function used to wrap the JSON response","schema":{"type":"string"}},{"name":"apikey","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/Response"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Response"}}}}}},"post":{"tags":["Route Matching V8"],"summary":"Match GPS traces to get the most probably driven path. Use &routeMatch=1 for default route matching behavior. Compatible with version 2 route matching.","operationId":"matchRouteV8compatibilityToV2_1","parameters":[{"name":"driver_cost","in":"query","description":"Cost per hour in target currency.","required":false,"schema":{"type":"string"}},{"name":"vehicle_cost","in":"query","description":"Cost per kilometer in target currency.","required":false,"schema":{"type":"string"}},{"name":"vehicleCostOnFerry","in":"query","description":"Cost per kilometer on ferry in target currency. Default = vehicle_cost.","required":false,"schema":{"type":"string"}},{"name":"currency","in":"query","description":"3 letter ISO currency symbol. Required if toll cost must be added up across different currencies and/or be added to driver/vehicle/fuel cost in different currencies.","required":false,"schema":{"type":"string"},"example":"USD"},{"name":"departure","in":"query","description":"Format: now, yyyy-MM-dd'T'HH:mm:ss or yyyy-MM-dd'T'HH:mm:ssX. If no timezone is specified, then the local timezone at the route start link is used. Default: Ignore all time dependent access restrictions. Special values: ignoreTimeDepRestr (like default), obeyTimeDepRestr (all time dependent restrictions apply).","required":false,"schema":{"type":"string"}},{"name":"tollVehicleType","in":"query","description":"Vehicle type for toll calculation, use only if toll should also be estimated for the matched route. Possible values: 1=Motorcycle, 2=Auto, 3=Truck, 4=Motor home, 5=Minibus, 6=Bus, 7=Motorcycle Sidecar(EU), 8=Tricycle(EU), 9=Delivery Truck(EU+India), 10=Snowmobile(US), 11=Pick-up(US+India), 12=Tractor(US+India), 13=Taxi, 14=HCM/EME (India Heavy Construction Machinery/Earth Moving Equipment)","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","description":"0=None, 1=Caravan, 2=Trailer, 3=RVTrailer, 4=BoatTrailer. For toll cost and recreational vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","description":"Number of trailers, 0...4. For toll cost and truck restrictions. 0=no trailer, 1=one or more trailers, 2=two or more trailers, 3=three or more trailers. For truck restrictions: 4=one or more semi-trailers.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","description":"Number of axles excluding trailers. For toll cost and for country wide truck restrictions.
","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","description":"Number of trailer axles. For toll cost and for country wide truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","description":"1=fuel+electric, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","description":"1=EURO I, 2=EURO II, 3=EURO III, 4=EURO IV, 5=EURO V, 6=EURO VI, 7=EURO EEV, 8=Electric Vehicles, 9=EURO II with PRC, 10=EURO III with PRC. For toll cost and environmental zone restrictions, when emissionType is not specified it defaults to 5.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","description":"CO2 emission class of the vehicle. 1=Emission class 1, 2=Emission class 2, 3=Emission class 3, 4=Emission class 4, 5=Emission class 5. For toll cost only, when co2EmissionClass is not specified then it defaults to 1. Providing invalid combination of emissionType and co2EmissionClass in request may result in incorrect toll costs.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","description":"Actual height of the overall rigid/semi truck including trailers: 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","description":"Actual height of the trailer(s). 350cm or 3.5m or 138in. For toll cost only, not considered for route path creation (use height parameter)
(Not available for Waypoints Sequence).","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","description":"Actual total weight of vehicle incl. payload, but not trailers' weight or payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","description":"Actual total weight of vehicle incl. payload and trailers/caravan incl. their payload. 7.5t or 7500kg or 16500lbs. For truck restrictions, speed profile, toll cost and environmental zone restrictions. See also vehicleWeight. Note that country wide weight restrictions depend on the number of axles and trailers as well, so it might be necessary to specify them as well.","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Legal maximum weight limit of vehicle incl. payload and trailers. Also incl. their payload as a total. 7.5t or 7500kg or 16500lbs. For truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","description":"1=vehicle equipped to carry disabled people, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","description":"Actual number of passengers. For toll cost. See also vehicle type carHOV.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","description":"Number of tires. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","description":"1=vehicle registered for commercial use, 0=otherwise. For toll cost, environmental zone regulations and delivery-only zones.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","description":"Comma separated list from explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable. For toll cost (only explosive and other) and for truck restrictions. For Waypoints Sequence, allhazardousGoods and explosiveFlammable are not supported.","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","description":"350cm or 3.5m or 138in. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","description":"Length of the vehicle (including potential trailers). 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxle","in":"query","description":"Actual total weight per axle, incl. payload. 7.5t or 7500kg or 16500lbs (Waypoints Sequence in kg, no unit). For toll cost and truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"width","in":"query","description":"Width of the vehicle, e.g. 350cm or 3.5m or 138in. For truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"tunnelCategory","in":"query","description":"Defines the tunnel categories the truck must NOT use. B, C, D or E. A tunnels have no restrictions. E tunnels have most restrictions. If C is defined, the route will use A and B tunnels but not C, D or E.","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","description":"Defines the fuel powering the vehicle. Can be Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric. (LPG=Liquefied Petroleum Gas, LNG=Liquefied Natural Gas). Used f.e. for environmental zone restrictions, toll cost calculation, consumption based routing for Electric vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"weightPerAxleGroup","in":"query","description":"Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported names are drive, single, tandem, triple, quad, quint. Example: &weightPerAxleGroup=drive:12;single:11;tandem:18
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailerWeight","in":"query","description":"Actual total weight of trailers with their payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.","required":false,"schema":{"type":"string"}},{"name":"overlays","in":"query","description":"Overlay map name. Case insensitive. Must start with OVERLAY and contain only characters.","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"Semicolon separated list of the route type, vehicle type, traffic options and additional optional parameters. As optional parameters, following avoid road types can be specified (semicolon separated by avoid level) - motorway 0, -1, -2, -3), tollroad (0, -1, -2, -3), boatFerry (0, -1, -2, -3), railFerry (0, -1, -2, -3), and tunnel (0, -1, -2, -3). Format - shortest|fastest;vehicletype;traffic:enabled|disabled|default;motorway:0|-1|-2|-3;tollroad:0|-1|-2|-3;boatFerry:0|-1|-2|-3;railFerry:0|-1|-2|-3;tunnel:0|-1|-2|-3. Vehicle types supported: bdouble, bicycle, bus, car, carHOV, custom1, emergency, motorcycle, pedestrian, roadtrain, taxi, truck. \"shortest\" and \"balanced\" are not supported but can be individually tuned using &driver_cost and &vehicle_cost. ","required":false,"schema":{"type":"string"}},{"name":"restTimes","in":"query","description":"Parameter to enable driver rest time calculations based on legal drive/rest intervals. Specify 'local' to obey the legal driver rest times of the respective country. Alternatively, proprietary values can be set for DriveTimeUntilShortBreak, ElapsedTimeUntilShortBreak, ShortBreakDuration, DriveTimeUntilLongRest, ElapsedTimeUntilLongBreak, LongRestDuration. E.g. EU requires after 4.5h a 45min break + after 9h an 11h rest. If the driver is not fresh then add ,TimeAlreadyDrivenSinceLastShortBreak, ElapsedTimeSinceLastShortBreak, TimeAlreadyDrivenSinceLastLongRest, ElapsedTimeSinceLastLongRest in seconds. Specify ;earlierRestTimeFactor:0.0 to take rest times much earlier to reduce travel time (arriving with less legal driving time left), default = 0.75","required":false,"schema":{"type":"string"}},{"name":"language","in":"query","description":"Language for the maneuver instructions in the response. Currently de-de, en-us, it-it, fr-fr, es-es, pt-pt, pl-pl, zh-cn, zh-tw, zh-hk and ja-jp are supported. If not specified, en-us is used.","required":false,"schema":{"type":"string"}},{"name":"avoidLinks","in":"query","description":"Comma separated list of link ids or lat,lon[;heading] coordinates to be avoided. Positive ids are not driven from reference node, negative ids are not driven towards reference node. Use '*' prefix to avoid both directions. For coordinates direction of blocking depends on the heading. If no heading given both directions will be avoided. Optionally an entry penalty (applied once while entering the sequence of link(s)) and drive penalty (applied to every link) can be specified individually for each link to be avoided, format: 'linkId[;penalty:entryPenaltySec[:drivePenaltyFactor]] or lat,lon[;penalty:entryPenaltySec[:drivePenaltyFactor]]'. entryPenalty should be between -120 and 600 (-ve penalty implies prefer), drivePenaltyFactor should be between 0.1 and 20.0 (1.0 implies no penalty, < 1.0 implies prefer). e.g. 1308094486;penalty:60:1.5,-1308094485;penalty:2:2.5 .","required":false,"schema":{"type":"string"}},{"name":"avoidAreas","in":"query","description":"List of areas (rectangles or polygons) to be avoided. Areas are separated by '!'. Rectangles can be specified with two diagonal coordinates separated by ';', e.g. latMax,lonMin;latMin,lonMax. Polygons are specified with consecutive vertex coordinates separated by ';', e.g. lat1,lon1;lat2,lon2;lat3,lon3;... ","required":false,"schema":{"type":"string"}},{"name":"arrival","in":"query","description":"Format like departure. Use this to find out when you have to start the journey to arrive at the given time. Note that toll cost is not considered when arrival time is specified.","required":false,"schema":{"type":"string"},"example":"2022-11-16T12:54:14+10"},{"name":"rollups","in":"query","description":"Comma separated list of rollups (groupings, aggregation levels) for the toll cost response. Currently supported values are: none (toll cost details per link), total (overall total toll cost only), tollsys (toll cost summary per toll system), country (summary per country), country;tollsys (summary per country and toll system). Example: &rollups=none,country;tollsys,country returns the individual linl level cost details and 2 different summaries.","required":false,"schema":{"type":"string"}},{"name":"tollPass","in":"query","description":"Comma separated list of owned passes for toll cost calculation. Supported values: Senior_Pass, transponder (meaning the car has all transponders), allPasses, Annual, Nr_of_Days, Nr_of_Months (meaning the car has all passes valid for this number of months), AutoPass, SunPass, E-Z Pass (last 2 are examples for real toll transponders). Can also list toll system ids or toll booth condition ids. Allows traversal of 'transponder-only' toll booths, allows cost free traversal of certain toll sections and allows using cheaper prices for transponder/pass owners.","required":false,"schema":{"type":"string"}},{"name":"speedFcCat","in":"query","description":"Comma separated list of speeds driven in kilometer per hour per road functional class (1-5 + Virtual Connections VC) and speed category (1-8) (f.e. FC1-SC1,FC1-SC2,...,FC1-SC8;FC2-SC1,FC2-SC2,...;...;VC-SC1,FC-SC2,...VC-SC8). Functional classes are semicolon separated. Can contain empty entries (no change to default f.e. 80,76,,,,,,;,,,54,46,,,;...). Overrides router's default driven speed values. Also one of the predefined profiles can be activated by value car, light-truck, medium-truck or heavy-truck","required":false,"schema":{"type":"string"}},{"name":"routeAttributes","in":"query","description":"Defines which information is included in the response route part of the calculated route. Defaults to mode (mo), waypoints (wp), summary (sm), flags (fl). Also supported: speedProfile (sp), shape (sh), summaryByCountry (sc), boundingBox (bb), none. Can be excluded in the response by putting a hyphen in the front. e.g. -wp","required":false,"schema":{"type":"string"}},{"name":"responseAttributes","in":"query","description":"Defines which information is included in the response as part of the calculated route. Defaults to warnings (wn). Also supported: language (lg), polyline(polyline), summary(summary), actions(actions), routehandle(routehandle), turnbyturnactions(turnbyturnactions), none. Can be excluded in the response by putting a hyphen in the front. e.g. -wn","required":false,"schema":{"type":"string"}},{"name":"metaAttributes","in":"query","description":"Defines which information is included in the meta part of the calculated route. Defaults to none. Also supported: version (ver). Can be excluded in the response by putting a hyphen in the front. e.g. -ver","required":false,"schema":{"type":"string"}},{"name":"maneuverAttributes","in":"query","description":"Defines which information is included in the response as part of the data representation of the route maneuvers. Defaults to position (po), length (le), travelTime (tt). Also supported: direction (di), action (ac), indices (ix), lanes (ln), roadName(rn), nextRoadName (nr), beforeAfter (ba) and none.","required":false,"schema":{"type":"string"}},{"name":"legAttributes","in":"query","description":"Defines which information is included in the response as part of the route legs. Defaults to links (li), maneuvers (mn), length (le), travelTime (tt), baseTime (bt), trafficTime (tm). Also supported: shape (sh), boundingBox (bb), turnbyturnmaneuvers (mm), none. Can be excluded in the response by putting a hyphen in the front. e.g. -mn. Also in RouteMatch mode legAttributes=mn is supported.","required":false,"schema":{"type":"string"}},{"name":"linkAttributes","in":"query","description":"Define optional attributes to be returned for each link. Defaults to shape (sh), length (le), remainTime (rt), remainDistance (rd), functionalClass (fc), warnings (wn), confidence (cd), segmentRef (sr). Also supported: cost (co), maneuver (ma), timezone (tz), none. Can be excluded in the response by putting a hyphen in the front. e.g. -ma","required":false,"schema":{"type":"string"}},{"name":"traverseGates","in":"query","description":"Assume the driver has keys/permissions to traverse gates, if \"true\". Accepted values are either \"true\" or \"airlineDistanceInMeters,entryPenaltyInSec\". Accepted values are either \"true\" or \"airlineDistanceInMeters,entryPenaltyInSec\". Default = don't traverse any gates unless vehicle type is emergency.","required":false,"schema":{"type":"string"}},{"name":"routeMatch","in":"query","description":"Parameter to chose the operational mode of the Route Matching algorithm, supported values are 0|1|2. Default mode if not specified is 0 - Computes a legal route that goes through all way points. 1 - Route Matching mode, treats the waypoints (or trace file POST body) as a GPS trace and return the most probable matched route along this trace. 2 - ETA Tracking mode, computes the route based on waypoints specified, in addition, it uses the POST body GPS trace to detect any taken driver rest times/break and reached/skipped waypoints. To get maneuvers for a matched route specify &legAttributes=mn.","required":false,"schema":{"type":"string"}},{"name":"legal","in":"query","description":"For mode routeMatch=1. Enforces a legal route w.r.t. the following route condition types (comma separated list): access,gate,oneway,thrutraf,turn. Passing all of them yields a legal route as from a router. access - use only links allowed for the vehicle type (incl. truck measures). gate - don't traverse gates. oneway - don't drive links into forbidden direction. thrutraf - don't enter+leaving 'no through traffic' zones. turn - don't turn/u-turn illegally. Default: avoid illegal maneuvers, but use them if the trace obviously used them. If used, return respective warnings.","required":false,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"Comma separated list of Map Attributes layer names, to get additonal attributes along the route. Only link-based attribute layers (roughly those ending in _FC1, _FC2 ... ) are supported. Specify FCn to get content from specific functional class layer corresponding to the link. After each layer name, comma separated list of individual layer attributes can be listed within brackets, or specify (*) to get all layer attributes. Example: &attributes=ROAD_GEOM_FCn(TUNNEL), SPEED_LIMITS_FCn (FROM_REF_SPEED_LIMIT, TO_REF_SPEED_LIMIT), ADAS_ATTRIB_FCn (SLOPES). A maximum of 32 layers can be requested per request.","required":false,"schema":{"type":"string"},"example":"SPEED_LIMITS_FCN"},{"name":"customConsumptionDetails","in":"query","description":"Semicolon separated list of speed/ascent/descent/builtupFactor/auxilliaryConsumption fuel consumption parameters. Speed is a list of $/km for different speeds. Ascent/descent are additional $/km per altitude climbed or descended. Builtup factor is an optional heuristic consumption multiplier for urban area, default value is 1.55. auxilliaryConsumption is the additional consumption (per hour) for running auxilliary units (climate control, infotainment, lights, etc.). Cost unit is not $ but 'currency'. Example: speed,0,0.102,10,0.084,30,0.066,50,0.06,70,0.066,100,0.072,120,0.084,140,0.108; ascent,0.4; descent,0.1; builtupFactor,1.4 = at 70 kph the car consumes 6.6$/100km and 0.4$/km altitude climbed, consumption increases 40% in urban area. Alternatively, user can specify default consumption profile: 3.5t, 7.5t, 18t, 40t or weightDependent. In case of the weightDependent consumption profiles will be decided based on the limitedWeight so this parameter also needs to be specified.","required":false,"schema":{"type":"string"}},{"name":"alternatives","in":"query","description":"Only for routeMatch=0. Maximum number of alternative route options to return. Can return less or no alternatives. Only returns route alternatives that significantly differ from the best route but are not much more costly.","required":false,"schema":{"type":"string"}},{"name":"timeout","in":"query","description":"Routing calculation must be finished within this amount of milliseconds. Default 50000. Maximum 50000.","required":false,"schema":{"type":"string"}},{"name":"ignoreWaypointVehicleRestriction","in":"query","description":"Waypoint restrictions can be ignored by setting radius[;penaltyFactor[;all]]. For detailed information on this parameter and its usage, please see Dev Guide \"Concepts - Find a path despite access restrictions\".","required":false,"schema":{"type":"string"}},{"name":"maxSpeed","in":"query","description":"Maximum speed allowed for the whole route. Supported units are kmh (kilometres per hour), mph (miles per hour) and mps (metres per second). If no unit is provided, kmh will be used as default unit.","required":false,"schema":{"type":"string"}},{"name":"alignToGpsTime","in":"query","description":"Only for routeMatch=1 and 2. Route matching tries to align the driving time to the GPS timestamps in trace (if available). Supported values: 0|1. This feature is enabled by default (1), set the value 0 to disable it.","required":false,"schema":{"type":"string"}},{"name":"customAttributes","in":"query","description":"Comma separated list of Customer (BYOD) layer names, to get link attributes along the route. Format follows the 'attribute' parameter. No FCn notation supported.","required":false,"schema":{"type":"string"}},{"name":"mapMatchRadius","in":"query","description":"Maximum adaptive map match search radius [in meter] that will be applied to each waypoint. If specified it overrides waypoints' transitRadius values and the default maximum adaptive search radius. For routing (mode routeMatch=0), default value is: 1600, max limit: 5000.","required":false,"schema":{"type":"string"}},{"name":"excludeZoneTypes","in":"query","description":"Only for routeMatch=0, not supported for route matching. Specify if the route may not enter a specific zone type. Currently supported values: environmental,vignette and congestionPricing. If omitted or empty, zone restrictions are not taken into account. ","required":false,"schema":{"type":"string"}},{"name":"instructionFormat","in":"query","description":"To choose the maneuver instruction text representation format in response. Supported formats are text or html","required":false,"schema":{"type":"string"}},{"name":"oneway","in":"query","description":"Option to control oneway violation behavior, default - obey all oneways. Format - 'penalty':penaltyFactor, eg. 'penalty:0.5' - allows oneway violation if the time benefit is more than 0.5 sec/meter. For bicycle recommended value 0.125, for emergencies 0.5. Not allowed for other vehicles.","required":false,"schema":{"type":"string"}},{"name":"drivingReport","in":"query","description":"Parameter to enable the Advanced driving analytics / driving report feature, added to the route match response. Set to 1 to enable it, disabled by default.","required":false,"schema":{"type":"string"}},{"name":"ignorePreferredRoutes","in":"query","description":"Only for routeMatch=0. Preferred routes for a specific vehicle type are taken by default. To turn if off set ignorePreferredRoutes to true.","required":false,"schema":{"type":"string"}},{"name":"avoidTurns","in":"query","description":"Comma separated list of elements like left[;minAngleDegree;penaltySec] or right... or uTurn[;penaltySec] if a left/right turn is sharper than the specified angle (0...180) then the given time penalty is applied. uTurnAtWaypoint avoids u-turning on the link directly where the waypoint was reached.","required":false,"schema":{"type":"string"}},{"name":"ignoreZeroSpeedPoints","in":"query","description":"Only for routeMatch=1 and 2. Default = consider all points. 1 = ignore trace points that have zero speed (only in traces that provide speed but not time).","required":false,"schema":{"type":"string"}},{"name":"wpDist","in":"query","description":"Only for routeMatch=1 and 2. Default value = 0, feature is disabled. 1 = return spatial distance between matched trace points. 2 = return spatial distance between original trace points","required":false,"schema":{"type":"string"}},{"name":"customRestrLimit","in":"query","description":"Comma separated list of key value pairs of custom restriction limits. The key and value of individual custom restriction limit must be numeric and must be separated by colon. Example: 0:10,1:20,2:50","required":false,"schema":{"type":"string"}},{"name":"learnStopsId","in":"query","description":"Only for routeMatch=2. Identifier of a profile to learn stop characteristics. Profiles can be defined arbitrarily, e.g by driver, vehicle, departure time or a combination of them. Parameter is used to learn while route matching. Cannot be used together with learnedStopsId.","required":false,"schema":{"type":"string"}},{"name":"learnedStopsId","in":"query","description":"Only for routeMatch=2. Identifier of a already learned profile, to be used for stop characteristics. Profiles can be defined arbitrarily, e.g by driver, vehicle, departure time or a combination of them. Parameter is to apply learnings while routing. Cannot be used together with learnStopsId.","required":false,"schema":{"type":"string"}},{"name":"routeMatch2PlannedWayPointReachRadius","in":"query","description":"Only for routeMatch=2. If vehicle approaches a planned waypoint closer than this then the waypoint is considered reached. Default 20000.0m.","required":false,"schema":{"type":"string"}},{"name":"detectSkippedPlannedWaypoint","in":"query","description":"Only for routeMatch=2. Default to true. This flag enables/disables the logic to analyze the GPS trace and determines which planned waypoints are skipped. You can prevent waypoint skipping by setting this value to false.","required":false,"schema":{"type":"string"}},{"name":"plannedWaypointReachTolerance","in":"query","description":"Only for routeMatch=2 with learned stops. Default = 20000 meter. If the trace gets closer then the learned stop is considered reached","required":false,"schema":{"type":"string"}},{"name":"ignoreWaypointsFarFromNeighbors","in":"query","description":"Only for routeMatch=2. Default = true, if 'false' then algorithm does not ignore a trace point when it is much further away from its neighbors than the usual distances in the trace","required":false,"schema":{"type":"string"}},{"name":"wayPointHeadingMismatchPenaltyFactor","in":"query","description":"Tie waypoints closer to links where the GPS heading matches the link's heading, and try harder to meet waypoints in the given driving direction. Default = 1.","required":false,"schema":{"type":"string"}},{"name":"avoidPrivate","in":"query","description":"Option to use private streets for routing, routeMatch=0 and 2. Set it to '1' to always allow access to private street, '-1' to always forbid it. Default is '0' - access is allowed if there is a waypoint in the private street.","required":false,"schema":{"type":"string"}},{"name":"licensePlate","in":"query","description":"Licenseplate of the vehicle. The vehicles registration number can influence the permission to drive in certain zones, mostly environmental zones.","required":false,"schema":{"type":"string"}},{"name":"adminTruckRestrictions","in":"query","description":"By default all admin wide truck restrictions are obeyed by the algorithm. If set to 'ignore', it will ignore them.","required":false,"schema":{"type":"string"}},{"name":"mapMatchTolerance","in":"query","description":"Map match tolerance [meter]. Will be applied to each way point. Routing can meet the waypoint on all links that are that much further away from the coordinate than the nearest. Default 3.0.","required":false,"schema":{"type":"string"}},{"name":"costPerConsumptionUnit","in":"query","description":"The cost of a consumption unit in targetCurrency. Default is 1.","required":false,"schema":{"type":"string"}},{"name":"restTimeDriverCost","in":"query","description":"Cost per hour in target currency while driver is taking a legal rest time. Can be between 0 and driver_cost value.","required":false,"schema":{"type":"string"}},{"name":"avoidFeatures","in":"query","description":"Comma separated list of road features to be avoided. Currently supported: unpaved[;300;50]. Avoids unpaved roads by the specified seconds to enter (Entry penalty) and seconds/km driven (drive peanlty), or a default penalty","required":false,"schema":{"type":"string"}},{"name":"truckVerified","in":"query","description":"Only for routeMatch=0. Make use of truck verified roads for truck routing. Set to 1 to prefer transport verified roads, -1 to avoid them. Default is 0 - access is allowed, but truck verified routes are not prefered or avoided.","required":false,"schema":{"type":"string"}},{"name":"avoidCountryChange","in":"query","description":"Only for routeMatch=0. Penalties in seconds to avoid unnecessary waiting time on border crossings. Countries should be specified according to 3 character ISO 3166 standard. A comma should be used to separate the multiple avoidChangeCountry on the route. Format: Country code1-Country code2:Penalty in seconds[,Country code1-Country code2:Penalty in seconds]","required":false,"schema":{"type":"string"}},{"name":"trafficIncidents","in":"query","description":"Set to 'true' or 'false to enable/disable usage of traffic incidents for route estimation for complete length of the route, default is 'false' - traffic incidents are disabled. Usage of traffic incidents will impact the routing response time, so use only if necessary.","required":false,"schema":{"type":"string"}},{"name":"pathCoordinates","in":"query","description":"Only for routeMatch=1. Set it to '1' or '0' to enable/disable provisioning a set of coordinates to reconstruct the journey using routing. A coordinate will be collected after each junction, if a minimum distance travveled since previous. This distance is by default 50m and can be changed by the sub-parameter minDist:, but not below 25m.","required":false,"schema":{"type":"string"}},{"name":"followPath","in":"query","description":"Only for routeMatch=1. Pass a sequence of link IDs defining the route path. Syntax: F: or L:LinkID0;LinkID1;...","required":false,"schema":{"type":"string"}},{"name":"waypoint0 ... waypointN","in":"query","description":"Comma separated waypoint latitude, longitude in WGS-84 degree. The coordinates may be directly followed by ;transitRadius;label;heading[;optional specifications]. \r\nA route must consist of at least 2 waypoints (start and destination). The coordinates may be directly followed by ;transitRadius;label;heading. \r\nThe maximum number of waypoints is limited. However, this limit is not a fixed number but is a result of the limit for the overall processing time. \r\nSet a transit radius to only influence the route to go via a certain city (Example: &waypoint1=50.12,8.65;10000). \r\nSet a heading (degree clockwise from North) to improve map matching (Example: &waypoint0=latitude,longitude;;;140). \r\nTo define a loading time or delay time at a waypoint, use stopOver[,timeInSeconds]! (Example: &waypoint1=stopOver,300!50.12,8.65). \r\nThe optional specifications altitude, custom label, !StreetPosition and !LinkPosition, ignoreRestriction are currently supported.\r\nTo define a radius around the waypoint where vehicle restrictions should be ignored use optional specification ';ignoreRestriction:radius[,drivePenalty[,type[,entryPenalty]]]. Example: &waypoint1=50.12,8.65;ignoreRestriction:8000,0.9,all,1800 . \r\nThis is similar to the global parameter 'ignoreWaypointVehicleRestriction' which applies to all waypoint. But when specified explicitly for a waypoint, the 'ignoreRestriction' specification of waypoint is applied. \r\nWaypoints can have opening and closing times, can be unsorted or optional. Details are in Key Concepts / Waypoint sorting, optional Pickup and Opening Times","required":true,"schema":{"type":"string"}},{"name":"jsonCallback","in":"query","description":"Specifies the function used to wrap the JSON response","schema":{"type":"string"}},{"name":"apikey","in":"query","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}},"description":"Only for routeMatch=1 and 2. Trace file for route matching, accepted trace formats - GPX, NMEA, KML, CSV or AGORA-C. Please refer the documentation page 'GPS trace formats and accuracy' for detailed information on trace file formats and supported trace attributes."}}}},"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/Response"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}},"/v8/maps/attributes":{"get":{"tags":["Map Attributes V8"],"summary":"Simple and fast access to the rich HERE Map Content, seamlessly extensible by your own map data","description":"Simple and fast access to the rich HERE Map Content, seamlessly extensible by your own map data","operationId":"v8GetMapAttributes","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"mapName","in":"query","description":"map name. Optional for public HERE maps and for private BYOD maps. If not specified, the content of all maps containing the requested layer(s) is retrieved","required":false,"schema":{"type":"string"}},{"name":"layers","in":"query","description":"Comma separated list of layers to be searched. Layer names are not case sensitive. Both custom layers and Map Attribute layers are supported. Map Attribute layers divided by functional class, like ROAD_GEOM_FC1 ... FC5 can be selected by N, e.g. ROAD_GEOM_FCN. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json. Via the attributes parameter only certain column attributes from a layer can be returned.","required":true,"schema":{"type":"string"}},{"name":"in","in":"query","description":"Spatial filtering. Supported are bbox, proximity, tile, corridor and all (full layer). \r\nThe format is &in=all or \r\n&in=bbox:{west longitude},{south latitude},{east longitude},{north latitude} or \r\n&in=proximity:latitude,longitude;r={radius} or \r\n&in=tile:{comma separated list of tile ids. The number of tile ids must match with the number of layers.} or \r\n&in=corridor:{comma separated WGS84 degree coordinates of corridor, for example:latitude 1,longitude 1,latitude 2,longitude 2 / encoded polyline string from Routing v8 response/ routeHandle string from Routing v8 response};r={radius}[;type=geoCoordinate(gc)/encodedPolyline(ep)/routeHandle(rh) }.\r\n When using routeHandle for corridor search an access token or apikey used for the router v8 service should be specified as Authorization header, else request will fail.","required":false,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"A SQL expression being evaluated for each geometry being returned from the specified layer listing.\r\nColumns value for the geometry are available as defined variables.\r\nWhen specified, only geometries where expression evaluates to true will be returned.\r\nSupported SQL filter operators are: '=', '!=', '>', '<', 'AND', 'OR', 'LIKE'.\r\nExample: filter=RATING > 3 AND NAME != 'MyPlace23' AND NAME LIKE 'FOOD%' \r\nParameter value must be url encoded when using special characters.\r\nThis filter expression is applied to all geometries, so it can become slow for big layers.\r\nTo avoid service overload, filter expressions must not exceed 100 characters of text. Please note that the filter expression is applied to all objects from all layers specified. For that reason it will most likely work as expected if a single layer is requested.","required":false,"schema":{"type":"string","default":""}},{"name":"link2stabletopologyid","in":"query","description":"When set to 1 then stable topology ids are returned in the response. The default value is 1.","required":false,"schema":{"type":"string","default":"1"}},{"name":"release","in":"query","description":"Map release quarter, e.g. 2015Q4, 161J0, 16153 or LATEST (= default) for the latest available map release quarter. Specifying a map release is strongly discouraged, because there is no guarantee how long old map releases are available, hence applications that specify a release might stop working when the release gets retired. To choose a (nearest to) specific snapshot of the live traffic speed record or archived weather layer, a UNIX timestamp (number of milliseconds since 1970) or a url encoded date in 2017-12-01T17:30:00+01:00 format can be passed.","required":false,"schema":{"type":"string"}},{"name":"meta","in":"query","description":"When set to 1 then meta info is returned in the response. The default value is 1.","required":false,"schema":{"type":"string","default":"1"}},{"name":"attributes","in":"query","description":"Semicolon separated list of column names (in uppercase) to specify which attributes shall appear in the result. If the request specifies several layers, then pass this for each layer, as a comma separated list. Default = all. F.e. if layers=LINK_ATTRIBUTE2_FCn,LINK_ATTRIBUTE_FCn,ROAD_GEOM_FCn are requested, then the columns can be restricted to only following attributes=PARKING_LOT_ROAD;CARPOOL_ROAD,PAVED;PRIVATE,BRIDGE;TUNNEL. Parking lot and carpool road are from layer LINK_ATTRIBUTE2_FCn, paved and private from LINK_ATTRIBUTE_FCn and bridge, tunnel from ROAD_GEOM_FCn layer.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"transportMode","in":"query","description":"Mode of transport to be used for the route calculation: car, truck, pedestrian. Required when routeHandle is used to retrieve attributes in corridor, please specify the same transportMode which was used to get the route handle from v8 Routing API.","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The number of geometries in the response. If more geometries satisfy the search/filter criteria, they will be suppressed. It is undefined, which of the matching geometries are returned, unless this parameter is used together with offset, which sorts the results set by geometry id.\nParameter can be a single value that applies to all layers, or a comma separated list equal in number to the number of layers specified in layer_id parameter.\nThe maximum number of records supported within a single request can be looked up in the /serviceconfiguration.json endpoint.","required":false,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"To paginate huge responses, this parameter specifies the lowest geometry id to be returned. If geometry ids are not known, then retrieve the first page using zero, and to retrieve subsequent pages then request highest geometry of current page + 1 (it doesn't matter whether this geometry id actually exists or not). Use this parameter together with count.\nParameter can be a single value that applies to all layers, or a comma separated list equal in number to the number of layers specified in layer_id parameter.","required":false,"schema":{"type":"string"}},{"name":"acceptMissingLayers","in":"query","description":"Optional. If this parameter is set to true, user will get list of geometries from available layers, even if some of the requested layers are missing. If none of the requested layers are found, service returns empty list.","required":false,"schema":{"type":"string"}},{"name":"geom","in":"query","description":"local, full or none. Specifies the geometry representation in the result. Default = local. Local geometry is used for map display purposes, returning geometry pieces that cover the given search radius, bounding box or corridor polygon. Full geometry is used for interactive editing, where the original geometry is required. Full geometry can only be retrieved for custom layers, for map None is used for applications like geofencing, which most of the time want to know only the ids of the geofence points/lines polygons they are in or near.","required":false,"schema":{"type":"string","default":"local"}},{"name":"owner_app_id","in":"query","description":"Owner app_id that was used to upload a layer. It is mandatory when a granted app_id is used to access the layer.","required":false,"schema":{"type":"string"}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/MapAttributesV8Response"}}}}}},"post":{"tags":["Map Attributes V8"],"summary":"Simple and fast access to the rich HERE Map Content, seamlessly extensible by your own map data","description":"Simple and fast access to the rich HERE Map Content, seamlessly extensible by your own map data","operationId":"v8GetMapAttributes_1","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"mapName","in":"query","description":"map name. Optional for public HERE maps and for private BYOD maps. If not specified, the content of all maps containing the requested layer(s) is retrieved","required":false,"schema":{"type":"string"}},{"name":"layers","in":"query","description":"Comma separated list of layers to be searched. Layer names are not case sensitive. Both custom layers and Map Attribute layers are supported. Map Attribute layers divided by functional class, like ROAD_GEOM_FC1 ... FC5 can be selected by N, e.g. ROAD_GEOM_FCN. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json. Via the attributes parameter only certain column attributes from a layer can be returned.","required":true,"schema":{"type":"string"}},{"name":"in","in":"query","description":"Spatial filtering. Supported are bbox, proximity, tile, corridor and all (full layer). \r\nThe format is &in=all or \r\n&in=bbox:{west longitude},{south latitude},{east longitude},{north latitude} or \r\n&in=proximity:latitude,longitude;r={radius} or \r\n&in=tile:{comma separated list of tile ids. The number of tile ids must match with the number of layers.} or \r\n&in=corridor:{comma separated WGS84 degree coordinates of corridor, for example:latitude 1,longitude 1,latitude 2,longitude 2 / encoded polyline string from Routing v8 response/ routeHandle string from Routing v8 response};r={radius}[;type=geoCoordinate(gc)/encodedPolyline(ep)/routeHandle(rh) }.\r\n When using routeHandle for corridor search an access token or apikey used for the router v8 service should be specified as Authorization header, else request will fail.","required":false,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"A SQL expression being evaluated for each geometry being returned from the specified layer listing.\r\nColumns value for the geometry are available as defined variables.\r\nWhen specified, only geometries where expression evaluates to true will be returned.\r\nSupported SQL filter operators are: '=', '!=', '>', '<', 'AND', 'OR', 'LIKE'.\r\nExample: filter=RATING > 3 AND NAME != 'MyPlace23' AND NAME LIKE 'FOOD%' \r\nParameter value must be url encoded when using special characters.\r\nThis filter expression is applied to all geometries, so it can become slow for big layers.\r\nTo avoid service overload, filter expressions must not exceed 100 characters of text. Please note that the filter expression is applied to all objects from all layers specified. For that reason it will most likely work as expected if a single layer is requested.","required":false,"schema":{"type":"string","default":""}},{"name":"link2stabletopologyid","in":"query","description":"When set to 1 then stable topology ids are returned in the response. The default value is 1.","required":false,"schema":{"type":"string","default":"1"}},{"name":"release","in":"query","description":"Map release quarter, e.g. 2015Q4, 161J0, 16153 or LATEST (= default) for the latest available map release quarter. Specifying a map release is strongly discouraged, because there is no guarantee how long old map releases are available, hence applications that specify a release might stop working when the release gets retired. To choose a (nearest to) specific snapshot of the live traffic speed record or archived weather layer, a UNIX timestamp (number of milliseconds since 1970) or a url encoded date in 2017-12-01T17:30:00+01:00 format can be passed.","required":false,"schema":{"type":"string"}},{"name":"meta","in":"query","description":"When set to 1 then meta info is returned in the response. The default value is 1.","required":false,"schema":{"type":"string","default":"1"}},{"name":"attributes","in":"query","description":"Semicolon separated list of column names (in uppercase) to specify which attributes shall appear in the result. If the request specifies several layers, then pass this for each layer, as a comma separated list. Default = all. F.e. if layers=LINK_ATTRIBUTE2_FCn,LINK_ATTRIBUTE_FCn,ROAD_GEOM_FCn are requested, then the columns can be restricted to only following attributes=PARKING_LOT_ROAD;CARPOOL_ROAD,PAVED;PRIVATE,BRIDGE;TUNNEL. Parking lot and carpool road are from layer LINK_ATTRIBUTE2_FCn, paved and private from LINK_ATTRIBUTE_FCn and bridge, tunnel from ROAD_GEOM_FCn layer.","required":false,"schema":{"type":"string"}},{"name":"transportMode","in":"query","description":"Mode of transport to be used for the route calculation: car, truck, pedestrian. Required when routeHandle is used to retrieve attributes in corridor, please specify the same transportMode which was used to get the route handle from v8 Routing API.","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The number of geometries in the response. If more geometries satisfy the search/filter criteria, they will be suppressed. It is undefined, which of the matching geometries are returned, unless this parameter is used together with offset, which sorts the results set by geometry id.\nParameter can be a single value that applies to all layers, or a comma separated list equal in number to the number of layers specified in layer_id parameter.\nThe maximum number of records supported within a single request can be looked up in the /serviceconfiguration.json endpoint.","required":false,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"To paginate huge responses, this parameter specifies the lowest geometry id to be returned. If geometry ids are not known, then retrieve the first page using zero, and to retrieve subsequent pages then request highest geometry of current page + 1 (it doesn't matter whether this geometry id actually exists or not). Use this parameter together with count.\nParameter can be a single value that applies to all layers, or a comma separated list equal in number to the number of layers specified in layer_id parameter.","required":false,"schema":{"type":"string"}},{"name":"acceptMissingLayers","in":"query","description":"Optional. If this parameter is set to true, user will get list of geometries from available layers, even if some of the requested layers are missing. If none of the requested layers are found, service returns empty list.","required":false,"schema":{"type":"string"}},{"name":"geom","in":"query","description":"local, full or none. Specifies the geometry representation in the result. Default = local. Local geometry is used for map display purposes, returning geometry pieces that cover the given search radius, bounding box or corridor polygon. Full geometry is used for interactive editing, where the original geometry is required. Full geometry can only be retrieved for custom layers, for map None is used for applications like geofencing, which most of the time want to know only the ids of the geofence points/lines polygons they are in or near.","required":false,"schema":{"type":"string","default":"local"}},{"name":"owner_app_id","in":"query","description":"Owner app_id that was used to upload a layer. It is mandatory when a granted app_id is used to access the layer.","required":false,"schema":{"type":"string"}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/MapAttributesV8Response"}}}}}}},"/v8/maps/attributes/segments":{"get":{"tags":["Map Attributes V8"],"summary":"Simple and fast access to the rich HERE Map Content, seamlessly extensible by your own map data","description":"The segments endpoint can be used to enrich multiple unconnected segments with HERE Map content attributes.","operationId":"v8GetMapAttributesForMultiSegment","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"mapName","in":"query","description":"Optional. Default: For public HERE maps all maps/regions containing the layer are returned, for private BYOD maps the layers from the DEFAULT map are returned","required":false,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"Comma separated list of PDE layer names, to get link attributes along the route. Only link attribute layers (roughly those ending in _FC1, _FC2 ... ) are supported. Specify FCn to get the layers of all functional classes. Behind each layer name attributes can be listed, or (*) to get all. Example: &attributes=ROAD_GEOM_FCn(TUNNEL), SPEED_LIMITS_FCn (FROM_REF_SPEED_LIMIT, TO_REF_SPEED_LIMIT), ADAS_ATTRIB_FCn (SLOPES). A maximum of 32 layers can be requested per request.","required":false,"schema":{"type":"string"}},{"name":"segmentRefs","in":"query","description":"Semi colon separated list of topology segmentRefs. Format of a SegmentRef is [Segment Identifier:]Segment Ref Id#Start Offset[..End Offset][,LAT,LON][,Remaining Time On Route,Functional Class]. Please use here:xs1:segment as the segment identifier for Japan segmentRefs and here:cm:segment for segmentRefs from rest of the world.","required":false,"schema":{"type":"string"}},{"name":"release","in":"query","description":"Map release, e.g. 2015Q4, 161J0, 23103 or LATEST (= default) for the latest available map release. Specifying a map release is strongly discouraged, because there is no guarantee how long old map releases are available, hence applications that specify a release might stop working when the release gets retired. To choose a specific snapshot of the the live traffic speed record or archived weather layer, a UNIX timestamp (number of milliseconds since 1970) or a date in 2017-12-01T17:30:00+01:00 format can be passed.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/MapAttributesAlongPathResponse"}}}}}},"post":{"tags":["Map Attributes V8"],"summary":"Simple and fast access to the rich HERE Map Content, seamlessly extensible by your own map data","description":"The segments endpoint can be used to enrich multiple unconnected segments with HERE Map content attributes.","operationId":"v8GetMapAttributesForMultiSegment_1","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"mapName","in":"query","description":"Optional. Default: For public HERE maps all maps/regions containing the layer are returned, for private BYOD maps the layers from the DEFAULT map are returned","required":false,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"Comma separated list of PDE layer names, to get link attributes along the route. Only link attribute layers (roughly those ending in _FC1, _FC2 ... ) are supported. Specify FCn to get the layers of all functional classes. Behind each layer name attributes can be listed, or (*) to get all. Example: &attributes=ROAD_GEOM_FCn(TUNNEL), SPEED_LIMITS_FCn (FROM_REF_SPEED_LIMIT, TO_REF_SPEED_LIMIT), ADAS_ATTRIB_FCn (SLOPES). A maximum of 32 layers can be requested per request.","required":false,"schema":{"type":"string"}},{"name":"segmentRefs","in":"query","description":"Semi colon separated list of topology segmentRefs. Format of a SegmentRef is [Segment Identifier:]Segment Ref Id#Start Offset[..End Offset][,LAT,LON][,Remaining Time On Route,Functional Class]. Please use here:xs1:segment as the segment identifier for Japan segmentRefs and here:cm:segment for segmentRefs from rest of the world.","required":false,"schema":{"type":"string"}},{"name":"release","in":"query","description":"Map release, e.g. 2015Q4, 161J0, 23103 or LATEST (= default) for the latest available map release. Specifying a map release is strongly discouraged, because there is no guarantee how long old map releases are available, hence applications that specify a release might stop working when the release gets retired. To choose a specific snapshot of the the live traffic speed record or archived weather layer, a UNIX timestamp (number of milliseconds since 1970) or a date in 2017-12-01T17:30:00+01:00 format can be passed.","required":false,"schema":{"type":"string"}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/MapAttributesAlongPathResponse"}}}}}}},"/v8/maps/attributes/path":{"get":{"tags":["Map Attributes V8"],"summary":"Simple and fast access to the rich HERE Map Content, seamlessly extensible by your own map data","description":"The path endpoint can be used to enrich a given continious route path with HERE Map content attributes.","operationId":"v8GetMapAttributesForAPath","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"mapName","in":"query","description":"Optional. Default: For public HERE maps all maps/regions containing the layer are returned, for private BYOD maps the layers from the DEFAULT map are returned","required":false,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"Comma separated list of PDE layer names, to get link attributes along the route. Only link attribute layers (roughly those ending in _FC1, _FC2 ... ) are supported. Specify FCn to get the layers of all functional classes. Behind each layer name attributes can be listed, or (*) to get all. Example: &attributes=ROAD_GEOM_FCn(TUNNEL), SPEED_LIMITS_FCn (FROM_REF_SPEED_LIMIT, TO_REF_SPEED_LIMIT), ADAS_ATTRIB_FCn (SLOPES). A maximum of 32 layers can be requested per request.","required":false,"schema":{"type":"string"}},{"name":"segmentRefs","in":"query","description":"Topology SegmentRefs as in Shortened or Full notation to define the path. Cannot be mixed with links, flexiblePolyline.","required":false,"schema":{"type":"string"}},{"name":"links","in":"query","description":"Link IDs or Full notation to define the path. Cannot be mixed with parameter segments, flexiblePolyline.","required":false,"schema":{"type":"string"}},{"name":"flexiblePolyline","in":"query","description":"Line string in [Flexible Polyline](https://github.com/heremaps/flexible-polyline) format. Cannot be mixed with parameter segments, links.","required":false,"schema":{"type":"string"},"example":"A05xgKuy2xCx9B7vUl0OhnR54EqSzpEl-HxjD3pBiGnyGi2CvwFsgD3nD4vB6e"},{"name":"transportMode","in":"query","description":"Optional, default=car. Relevant if 'applicable speed limits layer'. Supported vehicle types: bdouble, bicycle, bus, car, carHOV, emergency, motorcycle, pedestrian, roadtrain, taxi, truck, motorhome","required":false,"schema":{"type":"string"}},{"name":"departure","in":"query","description":"Format: now, yyyy-MM-dd'T'HH:mm:ss or yyyy-MM-dd'T'HH:mm:ssX. If no timezone is specified, then the local timezone at the route start link is used. Default: Ignore all time dependent access restrictions. Special values: ignoreTimeDepRestr (like default), obeyTimeDepRestr (all time dependent restrictions apply).","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","description":"0=None, 1=Caravan, 2=Trailer, 3=RVTrailer, 4=BoatTrailer. For toll cost and recreational vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","description":"Number of trailers, 0...4. For toll cost and truck restrictions. 0=no trailer, 1=one or more trailers, 2=two or more trailers, 3=three or more trailers. For truck restrictions: 4=one or more semi-trailers.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","description":"Number of axles excluding trailers. For toll cost and for country wide truck restrictions.
","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","description":"Number of trailer axles. For toll cost and for country wide truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","description":"1=fuel+electric, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","description":"1=EURO I, 2=EURO II, 3=EURO III, 4=EURO IV, 5=EURO V, 6=EURO VI, 7=EURO EEV, 8=Electric Vehicles, 9=EURO II with PRC, 10=EURO III with PRC. For toll cost and environmental zone restrictions, when emissionType is not specified it defaults to 5.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","description":"CO2 emission class of the vehicle. 1=Emission class 1, 2=Emission class 2, 3=Emission class 3, 4=Emission class 4, 5=Emission class 5. For toll cost only, when co2EmissionClass is not specified then it defaults to 1. Providing invalid combination of emissionType and co2EmissionClass in request may result in incorrect toll costs.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","description":"Actual height of the overall rigid/semi truck including trailers: 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","description":"Actual height of the trailer(s). 350cm or 3.5m or 138in. For toll cost only, not considered for route path creation (use height parameter)
(Not available for Waypoints Sequence).","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","description":"Actual total weight of vehicle incl. payload, but not trailers' weight or payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","description":"Actual total weight of vehicle incl. payload and trailers/caravan incl. their payload. 7.5t or 7500kg or 16500lbs. For truck restrictions, speed profile, toll cost and environmental zone restrictions. See also vehicleWeight. Note that country wide weight restrictions depend on the number of axles and trailers as well, so it might be necessary to specify them as well.","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Legal maximum weight limit of vehicle incl. payload and trailers. Also incl. their payload as a total. 7.5t or 7500kg or 16500lbs. For truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","description":"1=vehicle equipped to carry disabled people, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","description":"Actual number of passengers. For toll cost. See also vehicle type carHOV.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","description":"Number of tires. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","description":"1=vehicle registered for commercial use, 0=otherwise. For toll cost, environmental zone regulations and delivery-only zones.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","description":"Comma separated list from explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable. For toll cost (only explosive and other) and for truck restrictions. For Waypoints Sequence, allhazardousGoods and explosiveFlammable are not supported.","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","description":"350cm or 3.5m or 138in. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","description":"Length of the vehicle (including potential trailers). 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxle","in":"query","description":"Actual total weight per axle, incl. payload. 7.5t or 7500kg or 16500lbs (Waypoints Sequence in kg, no unit). For toll cost and truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"width","in":"query","description":"Width of the vehicle, e.g. 350cm or 3.5m or 138in. For truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"tunnelCategory","in":"query","description":"Defines the tunnel categories the truck must NOT use. B, C, D or E. A tunnels have no restrictions. E tunnels have most restrictions. If C is defined, the route will use A and B tunnels but not C, D or E.","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","description":"Defines the fuel powering the vehicle. Can be Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric. (LPG=Liquefied Petroleum Gas, LNG=Liquefied Natural Gas). Used f.e. for environmental zone restrictions, toll cost calculation, consumption based routing for Electric vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"weightPerAxleGroup","in":"query","description":"Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported names are drive, single, tandem, triple, quad, quint. Example: &weightPerAxleGroup=drive:12;single:11;tandem:18
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailerWeight","in":"query","description":"Actual total weight of trailers with their payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.","required":false,"schema":{"type":"string"}},{"name":"timeout","in":"query","description":"Operation must be finished within this amount of milliseconds. Default 50000. Maximum 50000.","required":false,"schema":{"type":"string"}},{"name":"release","in":"query","description":"Map release, e.g. 2015Q4, 161J0, 23103 or LATEST (= default) for the latest available map release. Specifying a map release is strongly discouraged, because there is no guarantee how long old map releases are available, hence applications that specify a release might stop working when the release gets retired. To choose a specific snapshot of the the live traffic speed record or archived weather layer, a UNIX timestamp (number of milliseconds since 1970) or a date in 2017-12-01T17:30:00+01:00 format can be passed.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/MapAttributesAlongPathResponse"}}}}}},"post":{"tags":["Map Attributes V8"],"summary":"Simple and fast access to the rich HERE Map Content, seamlessly extensible by your own map data","description":"The path endpoint can be used to enrich a given continious route path with HERE Map content attributes.","operationId":"v8GetMapAttributesForAPath_1","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"mapName","in":"query","description":"Optional. Default: For public HERE maps all maps/regions containing the layer are returned, for private BYOD maps the layers from the DEFAULT map are returned","required":false,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"Comma separated list of PDE layer names, to get link attributes along the route. Only link attribute layers (roughly those ending in _FC1, _FC2 ... ) are supported. Specify FCn to get the layers of all functional classes. Behind each layer name attributes can be listed, or (*) to get all. Example: &attributes=ROAD_GEOM_FCn(TUNNEL), SPEED_LIMITS_FCn (FROM_REF_SPEED_LIMIT, TO_REF_SPEED_LIMIT), ADAS_ATTRIB_FCn (SLOPES). A maximum of 32 layers can be requested per request.","required":false,"schema":{"type":"string"}},{"name":"segmentRefs","in":"query","description":"Topology SegmentRefs as in Shortened or Full notation to define the path. Cannot be mixed with links, flexiblePolyline.","required":false,"schema":{"type":"string"}},{"name":"links","in":"query","description":"Link IDs or Full notation to define the path. Cannot be mixed with parameter segments, flexiblePolyline.","required":false,"schema":{"type":"string"}},{"name":"flexiblePolyline","in":"query","description":"Line string in [Flexible Polyline](https://github.com/heremaps/flexible-polyline) format. Cannot be mixed with parameter segments, links.","required":false,"schema":{"type":"string"},"example":"A05xgKuy2xCx9B7vUl0OhnR54EqSzpEl-HxjD3pBiGnyGi2CvwFsgD3nD4vB6e"},{"name":"transportMode","in":"query","description":"Optional, default=car. Relevant if 'applicable speed limits layer'. Supported vehicle types: bdouble, bicycle, bus, car, carHOV, emergency, motorcycle, pedestrian, roadtrain, taxi, truck, motorhome","required":false,"schema":{"type":"string"}},{"name":"departure","in":"query","description":"Format: now, yyyy-MM-dd'T'HH:mm:ss or yyyy-MM-dd'T'HH:mm:ssX. If no timezone is specified, then the local timezone at the route start link is used. Default: Ignore all time dependent access restrictions. Special values: ignoreTimeDepRestr (like default), obeyTimeDepRestr (all time dependent restrictions apply).","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","description":"0=None, 1=Caravan, 2=Trailer, 3=RVTrailer, 4=BoatTrailer. For toll cost and recreational vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","description":"Number of trailers, 0...4. For toll cost and truck restrictions. 0=no trailer, 1=one or more trailers, 2=two or more trailers, 3=three or more trailers. For truck restrictions: 4=one or more semi-trailers.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","description":"Number of axles excluding trailers. For toll cost and for country wide truck restrictions.
","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","description":"Number of trailer axles. For toll cost and for country wide truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","description":"1=fuel+electric, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","description":"1=EURO I, 2=EURO II, 3=EURO III, 4=EURO IV, 5=EURO V, 6=EURO VI, 7=EURO EEV, 8=Electric Vehicles, 9=EURO II with PRC, 10=EURO III with PRC. For toll cost and environmental zone restrictions, when emissionType is not specified it defaults to 5.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","description":"CO2 emission class of the vehicle. 1=Emission class 1, 2=Emission class 2, 3=Emission class 3, 4=Emission class 4, 5=Emission class 5. For toll cost only, when co2EmissionClass is not specified then it defaults to 1. Providing invalid combination of emissionType and co2EmissionClass in request may result in incorrect toll costs.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","description":"Actual height of the overall rigid/semi truck including trailers: 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","description":"Actual height of the trailer(s). 350cm or 3.5m or 138in. For toll cost only, not considered for route path creation (use height parameter)
(Not available for Waypoints Sequence).","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","description":"Actual total weight of vehicle incl. payload, but not trailers' weight or payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","description":"Actual total weight of vehicle incl. payload and trailers/caravan incl. their payload. 7.5t or 7500kg or 16500lbs. For truck restrictions, speed profile, toll cost and environmental zone restrictions. See also vehicleWeight. Note that country wide weight restrictions depend on the number of axles and trailers as well, so it might be necessary to specify them as well.","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Legal maximum weight limit of vehicle incl. payload and trailers. Also incl. their payload as a total. 7.5t or 7500kg or 16500lbs. For truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","description":"1=vehicle equipped to carry disabled people, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","description":"Actual number of passengers. For toll cost. See also vehicle type carHOV.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","description":"Number of tires. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","description":"1=vehicle registered for commercial use, 0=otherwise. For toll cost, environmental zone regulations and delivery-only zones.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","description":"Comma separated list from explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable. For toll cost (only explosive and other) and for truck restrictions. For Waypoints Sequence, allhazardousGoods and explosiveFlammable are not supported.","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","description":"350cm or 3.5m or 138in. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","description":"Length of the vehicle (including potential trailers). 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxle","in":"query","description":"Actual total weight per axle, incl. payload. 7.5t or 7500kg or 16500lbs (Waypoints Sequence in kg, no unit). For toll cost and truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"width","in":"query","description":"Width of the vehicle, e.g. 350cm or 3.5m or 138in. For truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"tunnelCategory","in":"query","description":"Defines the tunnel categories the truck must NOT use. B, C, D or E. A tunnels have no restrictions. E tunnels have most restrictions. If C is defined, the route will use A and B tunnels but not C, D or E.","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","description":"Defines the fuel powering the vehicle. Can be Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric. (LPG=Liquefied Petroleum Gas, LNG=Liquefied Natural Gas). Used f.e. for environmental zone restrictions, toll cost calculation, consumption based routing for Electric vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"weightPerAxleGroup","in":"query","description":"Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported names are drive, single, tandem, triple, quad, quint. Example: &weightPerAxleGroup=drive:12;single:11;tandem:18
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailerWeight","in":"query","description":"Actual total weight of trailers with their payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.","required":false,"schema":{"type":"string"}},{"name":"timeout","in":"query","description":"Operation must be finished within this amount of milliseconds. Default 50000. Maximum 50000.","required":false,"schema":{"type":"string"}},{"name":"release","in":"query","description":"Map release, e.g. 2015Q4, 161J0, 23103 or LATEST (= default) for the latest available map release. Specifying a map release is strongly discouraged, because there is no guarantee how long old map releases are available, hence applications that specify a release might stop working when the release gets retired. To choose a specific snapshot of the the live traffic speed record or archived weather layer, a UNIX timestamp (number of milliseconds since 1970) or a date in 2017-12-01T17:30:00+01:00 format can be passed.","required":false,"schema":{"type":"string"}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/MapAttributesAlongPathResponse"}}}}}}},"/2/tollcost.json":{"get":{"tags":["Toll Cost Calculation"],"summary":"Adding toll cost information to a given route path","description":"Adding toll cost information to a given route path","operationId":"processTollCost","parameters":[{"name":"region","in":"query","required":false,"schema":{"type":"string"}},{"name":"release","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"vspec","in":"query","required":false,"schema":{"type":"string"}},{"name":"start_ts","in":"query","required":false,"schema":{"type":"string"}},{"name":"departure","in":"query","required":false,"schema":{"type":"string"}},{"name":"route","in":"query","required":false,"schema":{"type":"string"}},{"name":"currency","in":"query","required":false,"schema":{"type":"string"}},{"name":"tollVehicleType","in":"query","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","required":false,"schema":{"type":"string"}},{"name":"minimalPollution","in":"query","required":false,"schema":{"type":"string"}},{"name":"hov","in":"query","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","required":false,"schema":{"type":"string"}},{"name":"rollup","in":"query","required":false,"schema":{"type":"string"}},{"name":"overlays","in":"query","required":false,"schema":{"type":"string"}},{"name":"tollPass","in":"query","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Legal maximum weight limit of vehicle incl. payload and trailers. Also incl. their payload as a total.","required":false,"schema":{"type":"string"}},{"name":"timeout","in":"query","description":"TollCost calculation must be finished within this amount of milliseconds. Default 50000. Maximum 50000.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/TCResponse"}}}}}},"post":{"tags":["Toll Cost Calculation"],"summary":"Adding toll cost information to a given route path","description":"Adding toll cost information to a given route path","operationId":"processTollCost_1","parameters":[{"name":"region","in":"query","required":false,"schema":{"type":"string"}},{"name":"release","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"vspec","in":"query","required":false,"schema":{"type":"string"}},{"name":"start_ts","in":"query","required":false,"schema":{"type":"string"}},{"name":"departure","in":"query","required":false,"schema":{"type":"string"}},{"name":"route","in":"query","required":false,"schema":{"type":"string"}},{"name":"currency","in":"query","required":false,"schema":{"type":"string"}},{"name":"tollVehicleType","in":"query","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","required":false,"schema":{"type":"string"}},{"name":"minimalPollution","in":"query","required":false,"schema":{"type":"string"}},{"name":"hov","in":"query","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","required":false,"schema":{"type":"string"}},{"name":"rollup","in":"query","required":false,"schema":{"type":"string"}},{"name":"overlays","in":"query","required":false,"schema":{"type":"string"}},{"name":"tollPass","in":"query","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Legal maximum weight limit of vehicle incl. payload and trailers. Also incl. their payload as a total.","required":false,"schema":{"type":"string"}},{"name":"timeout","in":"query","description":"TollCost calculation must be finished within this amount of milliseconds. Default 50000. Maximum 50000.","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/TCResponse"}}}}}}},"/2/search/corridor.json":{"get":{"tags":["Search"],"summary":"Search for custom geometries within a polyline's corridor","description":"The number of geometries in the response should not exceed 1000. Exceeding one of the limits results in an error response. If an application needs more results returned then please contact technical customer support to work on a solution to reduce this.","operationId":"searchCorridor","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"radius","in":"query","description":"The buffer search radius in meters. All geometries overlapping the corridor polygon will be returned. Maximum radius is 5000.0 meter.","required":true,"schema":{"type":"number","format":"double"}},{"name":"layer_ids","in":"query","description":"Comma separated list of layer IDs to be searched. Layer names are not case sensitive. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json","required":true,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"List of comma separated column names to specify which attributes shall appear in the result. Column names are not case sensitive. Default = all.","required":false,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"A JavaScript expression being evaluated for each geometry matching search query.\r\nColumns value for the geometry are available as defined variables.\r\nWhen specified, only geometries where expression evaluates to true will be returned.\r\nExample: filter=RATING > 3 && NAME != 'MyPlace23' && NAME.startsWith('Food')\r\nParameter value must be url encoded when using special characters.\r\nThis filter expression is applied after the spatial filtering, hence only to few geometries. Only for the all.json the filter is applied to all geometries, so it can become very slow for big layers. Hence, following substring search expressions use database indexes and are much faster than other filter expressions (for updatable layers):\r\nCOL_NAME.indexOf(\"my_substring\") >= 0\r\nCOL_NAME.startsWith(\"my_prefix\")\r\nCOL_NAME == \"str\"\r\nCOL_NAME === \"str\"\r\nCOL_NAME != \"str\"\r\nCOL_NAME !== \"str\"\r\nCOL_NAME.indexOf(\"str\") >= 0\r\nCOL_NAME.startsWith(\"str\")\r\nCOL_NAME.like(\"%str%\")\r\nTo avoid service overload, filter expressions must not exceed 100 characters of text and their execution on the result must not exceed 100 ms execution time.","required":false,"schema":{"type":"string","default":""}},{"name":"corridor","in":"query","description":"Either corridor, route_id or routeHandle is required.\r\nThe WGS84 degree coordinates of the polyline used as corridor center line.\r\nFor example:\r\nlatitude 1,longitude 1;latitude 2,longitude 2;...","required":false,"schema":{"type":"string"}},{"name":"route_id","in":"query","description":"Either corridor, route_id or routeHandle is required.\r\nA route_id obtained from a previous v7.2 Router call. This route_id will be turned into a corridor polyline.","required":false,"schema":{"type":"string"}},{"name":"routeHandle","in":"query","description":"Either corridor, route_id or routeHandle is required.\r\nA routeHandle obtained from a previous v8 Router call. This routeHandle will be turned into a corridor polyline.","required":false,"schema":{"type":"string"}},{"name":"geom","in":"query","description":"local, full or none. Specifies the geometry representation in the result. Default = local. Local geometry is used for map display purposes, returning geometry pieces that cover the given search radius, bounding box or corridor polygon. Full geometry is used for interactive editing, where the original geometry is required. None is used for applications like geofencing, which most of the time want to know only the ids of the geofence points/lines polygons they are in or near.","required":false,"schema":{"type":"string","enum":["local","full","none"],"default":"local"}},{"name":"storage","in":"query","description":"Optional, default searches in both. Specify 'updatable' or 'readonly', how you uploaded the layer.","required":false,"schema":{"type":"string","default":"updatable"}},{"name":"map_name","in":"query","description":"Optional. Map within to look for the layer. Default: Look into the default map.","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"The routing mode (e.g. fastest;car;traffic:disabled) that determines how the route is calculated. When route_id/routeHandle is used for the corridor search then please specify the same mode which was used to get the route id or route handle.","required":false,"schema":{"type":"string"}},{"name":"transportMode","in":"query","description":"Mode of transport to be used for the calculation of the route: car, truck, pedestrian;It determines how the route is calculated. When routeHandle is used for the corridor search then please specify the same transportMode which was used to get the route handle.","required":false,"schema":{"type":"string"}},{"name":"routingMode","in":"query","description":"Specifies which optimization is applied during route calculation: fast, short;It determines how the route is calculated. When routeHandle is used for the corridor search then please specify the same routingMode which was used to get the route handle.","required":false,"schema":{"type":"string"}},{"name":"owner_app_id","in":"query","description":"Owner app_id that was used to upload the custom layer.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/GeometrySearchResponse"}}}}}},"post":{"tags":["Search"],"summary":"Search for custom geometries within a polyline's corridor","description":"The number of geometries in the response should not exceed 1000. Exceeding one of the limits results in an error response. If an application needs more results returned then please contact technical customer support to work on a solution to reduce this.","operationId":"searchCorridor_1","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"radius","in":"query","description":"The buffer search radius in meters. All geometries overlapping the corridor polygon will be returned. Maximum radius is 5000.0 meter.","required":true,"schema":{"type":"number","format":"double"}},{"name":"layer_ids","in":"query","description":"Comma separated list of layer IDs to be searched. Layer names are not case sensitive. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json","required":true,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"List of comma separated column names to specify which attributes shall appear in the result. Column names are not case sensitive. Default = all.","required":false,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"A JavaScript expression being evaluated for each geometry matching search query.\r\nColumns value for the geometry are available as defined variables.\r\nWhen specified, only geometries where expression evaluates to true will be returned.\r\nExample: filter=RATING > 3 && NAME != 'MyPlace23' && NAME.startsWith('Food')\r\nParameter value must be url encoded when using special characters.\r\nThis filter expression is applied after the spatial filtering, hence only to few geometries. Only for the all.json the filter is applied to all geometries, so it can become very slow for big layers. Hence, following substring search expressions use database indexes and are much faster than other filter expressions (for updatable layers):\r\nCOL_NAME.indexOf(\"my_substring\") >= 0\r\nCOL_NAME.startsWith(\"my_prefix\")\r\nCOL_NAME == \"str\"\r\nCOL_NAME === \"str\"\r\nCOL_NAME != \"str\"\r\nCOL_NAME !== \"str\"\r\nCOL_NAME.indexOf(\"str\") >= 0\r\nCOL_NAME.startsWith(\"str\")\r\nCOL_NAME.like(\"%str%\")\r\nTo avoid service overload, filter expressions must not exceed 100 characters of text and their execution on the result must not exceed 100 ms execution time.","required":false,"schema":{"type":"string","default":""}},{"name":"corridor","in":"query","description":"Either corridor, route_id or routeHandle is required.\r\nThe WGS84 degree coordinates of the polyline used as corridor center line.\r\nFor example:\r\nlatitude 1,longitude 1;latitude 2,longitude 2;...","required":false,"schema":{"type":"string"}},{"name":"route_id","in":"query","description":"Either corridor, route_id or routeHandle is required.\r\nA route_id obtained from a previous v7.2 Router call. This route_id will be turned into a corridor polyline.","required":false,"schema":{"type":"string"}},{"name":"routeHandle","in":"query","description":"Either corridor, route_id or routeHandle is required.\r\nA routeHandle obtained from a previous v8 Router call. This routeHandle will be turned into a corridor polyline.","required":false,"schema":{"type":"string"}},{"name":"geom","in":"query","description":"local, full or none. Specifies the geometry representation in the result. Default = local. Local geometry is used for map display purposes, returning geometry pieces that cover the given search radius, bounding box or corridor polygon. Full geometry is used for interactive editing, where the original geometry is required. None is used for applications like geofencing, which most of the time want to know only the ids of the geofence points/lines polygons they are in or near.","required":false,"schema":{"type":"string","enum":["local","full","none"],"default":"local"}},{"name":"storage","in":"query","description":"Optional, default searches in both. Specify 'updatable' or 'readonly', how you uploaded the layer.","required":false,"schema":{"type":"string","default":"updatable"}},{"name":"map_name","in":"query","description":"Optional. Map within to look for the layer. Default: Look into the default map.","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"The routing mode (e.g. fastest;car;traffic:disabled) that determines how the route is calculated. When route_id/routeHandle is used for the corridor search then please specify the same mode which was used to get the route id or route handle.","required":false,"schema":{"type":"string"}},{"name":"transportMode","in":"query","description":"Mode of transport to be used for the calculation of the route: car, truck, pedestrian;It determines how the route is calculated. When routeHandle is used for the corridor search then please specify the same transportMode which was used to get the route handle.","required":false,"schema":{"type":"string"}},{"name":"routingMode","in":"query","description":"Specifies which optimization is applied during route calculation: fast, short;It determines how the route is calculated. When routeHandle is used for the corridor search then please specify the same routingMode which was used to get the route handle.","required":false,"schema":{"type":"string"}},{"name":"owner_app_id","in":"query","description":"Owner app_id that was used to upload the custom layer.","required":false,"schema":{"type":"string"}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/GeometrySearchResponse"}}}}}}},"/2/findpickups.json":{"get":{"tags":["Waypoints Sequence"],"description":"Find Suitable Pickup and Delivery Locations.","operationId":"findPickupsOrSequence","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"start","in":"query","required":false,"schema":{"type":"string"}},{"name":"end","in":"query","required":false,"schema":{"type":"string"}},{"name":"driverCost","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"vehicleCost","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"maxDetour","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"capacity","in":"query","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","required":false,"schema":{"type":"string"}},{"name":"departure","in":"query","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","description":"0=None, 1=Caravan, 2=Trailer, 3=RVTrailer, 4=BoatTrailer. For toll cost and recreational vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","description":"Number of trailers, 0...4. For toll cost and truck restrictions. 0=no trailer, 1=one or more trailers, 2=two or more trailers, 3=three or more trailers. For truck restrictions: 4=one or more semi-trailers.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","description":"Number of axles excluding trailers. For toll cost and for country wide truck restrictions.
","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","description":"Number of trailer axles. For toll cost and for country wide truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","description":"1=fuel+electric, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","description":"1=EURO I, 2=EURO II, 3=EURO III, 4=EURO IV, 5=EURO V, 6=EURO VI, 7=EURO EEV, 8=Electric Vehicles, 9=EURO II with PRC, 10=EURO III with PRC. For toll cost and environmental zone restrictions, when emissionType is not specified it defaults to 5.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","description":"CO2 emission class of the vehicle. 1=Emission class 1, 2=Emission class 2, 3=Emission class 3, 4=Emission class 4, 5=Emission class 5. For toll cost only, when co2EmissionClass is not specified then it defaults to 1. Providing invalid combination of emissionType and co2EmissionClass in request may result in incorrect toll costs.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","description":"Actual height of the overall rigid/semi truck including trailers: 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","description":"Actual height of the trailer(s). 350cm or 3.5m or 138in. For toll cost only, not considered for route path creation (use height parameter)
(Not available for Waypoints Sequence).","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","description":"Actual total weight of vehicle incl. payload, but not trailers' weight or payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","description":"Actual total weight of vehicle incl. payload and trailers/caravan incl. their payload. 7.5t or 7500kg or 16500lbs. For truck restrictions, speed profile, toll cost and environmental zone restrictions. See also vehicleWeight. Note that country wide weight restrictions depend on the number of axles and trailers as well, so it might be necessary to specify them as well.","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Legal maximum weight limit of vehicle incl. payload and trailers. Also incl. their payload as a total. 7.5t or 7500kg or 16500lbs. For truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","description":"1=vehicle equipped to carry disabled people, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","description":"Actual number of passengers. For toll cost. See also vehicle type carHOV.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","description":"Number of tires. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","description":"1=vehicle registered for commercial use, 0=otherwise. For toll cost, environmental zone regulations and delivery-only zones.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","description":"Comma separated list from explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable. For toll cost (only explosive and other) and for truck restrictions. For Waypoints Sequence, allhazardousGoods and explosiveFlammable are not supported.","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","description":"350cm or 3.5m or 138in. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","description":"Length of the vehicle (including potential trailers). 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxle","in":"query","description":"Actual total weight per axle, incl. payload. 7.5t or 7500kg or 16500lbs (Waypoints Sequence in kg, no unit). For toll cost and truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"width","in":"query","description":"Width of the vehicle, e.g. 350cm or 3.5m or 138in. For truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"tunnelCategory","in":"query","description":"Defines the tunnel categories the truck must NOT use. B, C, D or E. A tunnels have no restrictions. E tunnels have most restrictions. If C is defined, the route will use A and B tunnels but not C, D or E.","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","description":"Defines the fuel powering the vehicle. Can be Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric. (LPG=Liquefied Petroleum Gas, LNG=Liquefied Natural Gas). Used f.e. for environmental zone restrictions, toll cost calculation, consumption based routing for Electric vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"weightPerAxleGroup","in":"query","description":"Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported names are drive, single, tandem, triple, quad, quint. Example: &weightPerAxleGroup=drive:12;single:11;tandem:18
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailerWeight","in":"query","description":"Actual total weight of trailers with their payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.","required":false,"schema":{"type":"string"}},{"name":"avoidLinks","in":"query","required":false,"schema":{"type":"string"}},{"name":"avoidAreas","in":"query","required":false,"schema":{"type":"string"}},{"name":"jsonCallback","in":"query","required":false,"schema":{"type":"string"}},{"name":"restTimes","in":"query","required":false,"schema":{"type":"string"}},{"name":"arrival","in":"query","required":false,"schema":{"type":"string"}},{"name":"sequence","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"region","in":"query","required":false,"schema":{"type":"string"}},{"name":"waypoint0 ... waypointN","in":"query","description":"Comma separated waypoint latitude, longitude in WGS-84 degree. The coordinates may be directly followed by ;transitRadius;label;heading[;optional specifications]. \r\nA route must consist of at least 2 waypoints (start and destination). The coordinates may be directly followed by ;transitRadius;label;heading. \r\nThe maximum number of waypoints is limited. However, this limit is not a fixed number but is a result of the limit for the overall processing time. \r\nSet a transit radius to only influence the route to go via a certain city (Example: &waypoint1=50.12,8.65;10000). \r\nSet a heading (degree clockwise from North) to improve map matching (Example: latitude,longitude;;;140). \r\nTo define a loading time or delay time at a waypoint, use stopOver[,timeInSeconds]! (Example: &waypoint1=stopOver,300!50.12,8.65). \r\nThe optional specifications altitude, custom label, !StreetPosition and !LinkPosition, ignoreRestriction are currently supported.\r\nTo define a radius around the waypoint where vehicle restrictions should be ignored use optional specification ';ignoreRestriction:radius[,drivePenalty[,type[,entryPenalty]]]. Example: &waypoint1=50.12,8.65;ignoreRestriction:8000,0.9,all,1800 . \r\nThis is similar to the global parameter 'ignoreWaypointVehicleRestriction' which applies to all waypoint. But when specified explicitly for a waypoint, the 'ignoreRestriction' specification of waypoint is applied. \r\nWaypoints can have opening and closing times, can be unsorted or optional. Details are in Key Concepts / Waypoint sorting, optional Pickup and Opening Times","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"type":"string"}}}}}},"post":{"tags":["Waypoints Sequence"],"description":"Find Suitable Pickup and Delivery Locations.","operationId":"findPickupsOrSequence_1","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"start","in":"query","required":false,"schema":{"type":"string"}},{"name":"end","in":"query","required":false,"schema":{"type":"string"}},{"name":"driverCost","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"vehicleCost","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"maxDetour","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"capacity","in":"query","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","required":false,"schema":{"type":"string"}},{"name":"departure","in":"query","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","description":"0=None, 1=Caravan, 2=Trailer, 3=RVTrailer, 4=BoatTrailer. For toll cost and recreational vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","description":"Number of trailers, 0...4. For toll cost and truck restrictions. 0=no trailer, 1=one or more trailers, 2=two or more trailers, 3=three or more trailers. For truck restrictions: 4=one or more semi-trailers.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","description":"Number of axles excluding trailers. For toll cost and for country wide truck restrictions.
","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","description":"Number of trailer axles. For toll cost and for country wide truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","description":"1=fuel+electric, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","description":"1=EURO I, 2=EURO II, 3=EURO III, 4=EURO IV, 5=EURO V, 6=EURO VI, 7=EURO EEV, 8=Electric Vehicles, 9=EURO II with PRC, 10=EURO III with PRC. For toll cost and environmental zone restrictions, when emissionType is not specified it defaults to 5.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","description":"CO2 emission class of the vehicle. 1=Emission class 1, 2=Emission class 2, 3=Emission class 3, 4=Emission class 4, 5=Emission class 5. For toll cost only, when co2EmissionClass is not specified then it defaults to 1. Providing invalid combination of emissionType and co2EmissionClass in request may result in incorrect toll costs.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","description":"Actual height of the overall rigid/semi truck including trailers: 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","description":"Actual height of the trailer(s). 350cm or 3.5m or 138in. For toll cost only, not considered for route path creation (use height parameter)
(Not available for Waypoints Sequence).","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","description":"Actual total weight of vehicle incl. payload, but not trailers' weight or payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","description":"Actual total weight of vehicle incl. payload and trailers/caravan incl. their payload. 7.5t or 7500kg or 16500lbs. For truck restrictions, speed profile, toll cost and environmental zone restrictions. See also vehicleWeight. Note that country wide weight restrictions depend on the number of axles and trailers as well, so it might be necessary to specify them as well.","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Legal maximum weight limit of vehicle incl. payload and trailers. Also incl. their payload as a total. 7.5t or 7500kg or 16500lbs. For truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","description":"1=vehicle equipped to carry disabled people, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","description":"Actual number of passengers. For toll cost. See also vehicle type carHOV.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","description":"Number of tires. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","description":"1=vehicle registered for commercial use, 0=otherwise. For toll cost, environmental zone regulations and delivery-only zones.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","description":"Comma separated list from explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable. For toll cost (only explosive and other) and for truck restrictions. For Waypoints Sequence, allhazardousGoods and explosiveFlammable are not supported.","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","description":"350cm or 3.5m or 138in. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","description":"Length of the vehicle (including potential trailers). 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxle","in":"query","description":"Actual total weight per axle, incl. payload. 7.5t or 7500kg or 16500lbs (Waypoints Sequence in kg, no unit). For toll cost and truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"width","in":"query","description":"Width of the vehicle, e.g. 350cm or 3.5m or 138in. For truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"tunnelCategory","in":"query","description":"Defines the tunnel categories the truck must NOT use. B, C, D or E. A tunnels have no restrictions. E tunnels have most restrictions. If C is defined, the route will use A and B tunnels but not C, D or E.","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","description":"Defines the fuel powering the vehicle. Can be Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric. (LPG=Liquefied Petroleum Gas, LNG=Liquefied Natural Gas). Used f.e. for environmental zone restrictions, toll cost calculation, consumption based routing for Electric vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"weightPerAxleGroup","in":"query","description":"Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported names are drive, single, tandem, triple, quad, quint. Example: &weightPerAxleGroup=drive:12;single:11;tandem:18
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailerWeight","in":"query","description":"Actual total weight of trailers with their payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.","required":false,"schema":{"type":"string"}},{"name":"avoidLinks","in":"query","required":false,"schema":{"type":"string"}},{"name":"avoidAreas","in":"query","required":false,"schema":{"type":"string"}},{"name":"jsonCallback","in":"query","required":false,"schema":{"type":"string"}},{"name":"restTimes","in":"query","required":false,"schema":{"type":"string"}},{"name":"arrival","in":"query","required":false,"schema":{"type":"string"}},{"name":"sequence","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"region","in":"query","required":false,"schema":{"type":"string"}},{"name":"waypoint0 ... waypointN","in":"query","description":"Comma separated waypoint latitude, longitude in WGS-84 degree. The coordinates may be directly followed by ;transitRadius;label;heading[;optional specifications]. \r\nA route must consist of at least 2 waypoints (start and destination). The coordinates may be directly followed by ;transitRadius;label;heading. \r\nThe maximum number of waypoints is limited. However, this limit is not a fixed number but is a result of the limit for the overall processing time. \r\nSet a transit radius to only influence the route to go via a certain city (Example: &waypoint1=50.12,8.65;10000). \r\nSet a heading (degree clockwise from North) to improve map matching (Example: latitude,longitude;;;140). \r\nTo define a loading time or delay time at a waypoint, use stopOver[,timeInSeconds]! (Example: &waypoint1=stopOver,300!50.12,8.65). \r\nThe optional specifications altitude, custom label, !StreetPosition and !LinkPosition, ignoreRestriction are currently supported.\r\nTo define a radius around the waypoint where vehicle restrictions should be ignored use optional specification ';ignoreRestriction:radius[,drivePenalty[,type[,entryPenalty]]]. Example: &waypoint1=50.12,8.65;ignoreRestriction:8000,0.9,all,1800 . \r\nThis is similar to the global parameter 'ignoreWaypointVehicleRestriction' which applies to all waypoint. But when specified explicitly for a waypoint, the 'ignoreRestriction' specification of waypoint is applied. \r\nWaypoints can have opening and closing times, can be unsorted or optional. Details are in Key Concepts / Waypoint sorting, optional Pickup and Opening Times","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"type":"string"}}}}}}},"/2/calculateroute.xml":{"get":{"tags":["Routing Extensions & Route Matching"],"operationId":"calculateRouteXML","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"driver_cost","in":"query","required":false,"schema":{"type":"string"}},{"name":"vehicle_cost","in":"query","required":false,"schema":{"type":"string"}},{"name":"vehicleCostOnFerry","in":"query","required":false,"schema":{"type":"string"}},{"name":"currency","in":"query","required":false,"schema":{"type":"string"}},{"name":"region","in":"query","required":false,"schema":{"type":"string"}},{"name":"release","in":"query","required":false,"schema":{"type":"string"}},{"name":"departure","in":"query","required":false,"schema":{"type":"string"}},{"name":"tollVehicleType","in":"query","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","description":"0=None, 1=Caravan, 2=Trailer, 3=RVTrailer, 4=BoatTrailer. For toll cost and recreational vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","description":"Number of trailers, 0...4. For toll cost and truck restrictions. 0=no trailer, 1=one or more trailers, 2=two or more trailers, 3=three or more trailers. For truck restrictions: 4=one or more semi-trailers.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","description":"Number of axles excluding trailers. For toll cost and for country wide truck restrictions.
","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","description":"Number of trailer axles. For toll cost and for country wide truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","description":"1=fuel+electric, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","description":"1=EURO I, 2=EURO II, 3=EURO III, 4=EURO IV, 5=EURO V, 6=EURO VI, 7=EURO EEV, 8=Electric Vehicles, 9=EURO II with PRC, 10=EURO III with PRC. For toll cost and environmental zone restrictions, when emissionType is not specified it defaults to 5.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","description":"CO2 emission class of the vehicle. 1=Emission class 1, 2=Emission class 2, 3=Emission class 3, 4=Emission class 4, 5=Emission class 5. For toll cost only, when co2EmissionClass is not specified then it defaults to 1. Providing invalid combination of emissionType and co2EmissionClass in request may result in incorrect toll costs.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","description":"Actual height of the overall rigid/semi truck including trailers: 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","description":"Actual height of the trailer(s). 350cm or 3.5m or 138in. For toll cost only, not considered for route path creation (use height parameter)
(Not available for Waypoints Sequence).","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","description":"Actual total weight of vehicle incl. payload, but not trailers' weight or payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","description":"Actual total weight of vehicle incl. payload and trailers/caravan incl. their payload. 7.5t or 7500kg or 16500lbs. For truck restrictions, speed profile, toll cost and environmental zone restrictions. See also vehicleWeight. Note that country wide weight restrictions depend on the number of axles and trailers as well, so it might be necessary to specify them as well.","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Legal maximum weight limit of vehicle incl. payload and trailers. Also incl. their payload as a total. 7.5t or 7500kg or 16500lbs. For truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","description":"1=vehicle equipped to carry disabled people, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","description":"Actual number of passengers. For toll cost. See also vehicle type carHOV.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","description":"Number of tires. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","description":"1=vehicle registered for commercial use, 0=otherwise. For toll cost, environmental zone regulations and delivery-only zones.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","description":"Comma separated list from explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable. For toll cost (only explosive and other) and for truck restrictions. For Waypoints Sequence, allhazardousGoods and explosiveFlammable are not supported.","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","description":"350cm or 3.5m or 138in. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","description":"Length of the vehicle (including potential trailers). 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxle","in":"query","description":"Actual total weight per axle, incl. payload. 7.5t or 7500kg or 16500lbs (Waypoints Sequence in kg, no unit). For toll cost and truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"width","in":"query","description":"Width of the vehicle, e.g. 350cm or 3.5m or 138in. For truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"tunnelCategory","in":"query","description":"Defines the tunnel categories the truck must NOT use. B, C, D or E. A tunnels have no restrictions. E tunnels have most restrictions. If C is defined, the route will use A and B tunnels but not C, D or E.","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","description":"Defines the fuel powering the vehicle. Can be Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric. (LPG=Liquefied Petroleum Gas, LNG=Liquefied Natural Gas). Used f.e. for environmental zone restrictions, toll cost calculation, consumption based routing for Electric vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"weightPerAxleGroup","in":"query","description":"Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported names are drive, single, tandem, triple, quad, quint. Example: &weightPerAxleGroup=drive:12;single:11;tandem:18
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailerWeight","in":"query","description":"Actual total weight of trailers with their payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.","required":false,"schema":{"type":"string"}},{"name":"useTrafficPattern","in":"query","required":false,"schema":{"type":"string"}},{"name":"overlays","in":"query","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","required":false,"schema":{"type":"string"}},{"name":"algopts","in":"query","required":false,"schema":{"type":"string"}},{"name":"restTimes","in":"query","required":false,"schema":{"type":"string"}},{"name":"language","in":"query","required":false,"schema":{"type":"string"}},{"name":"avoidLinks","in":"query","required":false,"schema":{"type":"string"}},{"name":"avoidAreas","in":"query","required":false,"schema":{"type":"string"}},{"name":"arrival","in":"query","required":false,"schema":{"type":"string"}},{"name":"rollups","in":"query","required":false,"schema":{"type":"string"}},{"name":"jsonAttributes","in":"query","required":false,"schema":{"type":"string"}},{"name":"speedFcCat","in":"query","required":false,"schema":{"type":"string"}},{"name":"routeAttributes","in":"query","required":false,"schema":{"type":"string"}},{"name":"responseAttributes","in":"query","required":false,"schema":{"type":"string"}},{"name":"metaAttributes","in":"query","required":false,"schema":{"type":"string"}},{"name":"maneuverAttributes","in":"query","required":false,"schema":{"type":"string"}},{"name":"legAttributes","in":"query","required":false,"schema":{"type":"string"}},{"name":"linkAttributes","in":"query","required":false,"schema":{"type":"string"}},{"name":"learnIdSpeed","in":"query","required":false,"schema":{"type":"string"}},{"name":"learnStopsId","in":"query","required":false,"schema":{"type":"string"}},{"name":"learnedStopsId","in":"query","required":false,"schema":{"type":"string"}},{"name":"traverseGates","in":"query","required":false,"schema":{"type":"string"}},{"name":"routeMatch","in":"query","required":false,"schema":{"type":"string"}},{"name":"legal","in":"query","required":false,"schema":{"type":"string"}},{"name":"linkaccess","in":"query","required":false,"schema":{"type":"string"}},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"}},{"name":"tollPass","in":"query","required":false,"schema":{"type":"string"}},{"name":"capacity","in":"query","required":false,"schema":{"type":"string"}},{"name":"customConsumptionDetails","in":"query","required":false,"schema":{"type":"string"}},{"name":"alternatives","in":"query","required":false,"schema":{"type":"string"}},{"name":"timeout","in":"query","required":false,"schema":{"type":"string"}},{"name":"ignoreWaypointVehicleRestriction","in":"query","required":false,"schema":{"type":"string"}},{"name":"maxSpeed","in":"query","required":false,"schema":{"type":"string"}},{"name":"alignToGpsTime","in":"query","required":false,"schema":{"type":"string"}},{"name":"customAttributes","in":"query","required":false,"schema":{"type":"string"}},{"name":"mapMatchRadius","in":"query","required":false,"schema":{"type":"string"}},{"name":"avoidCountry","in":"query","required":false,"schema":{"type":"string"}},{"name":"excludeZoneTypes","in":"query","required":false,"schema":{"type":"string"}},{"name":"preferMatchedVehicle","in":"query","required":false,"schema":{"type":"string"}},{"name":"requestId","in":"query","required":false,"schema":{"type":"string"}},{"name":"instructionFormat","in":"query","required":false,"schema":{"type":"string"}},{"name":"oneway","in":"query","required":false,"schema":{"type":"string"}},{"name":"drivingReport","in":"query","required":false,"schema":{"type":"string"}},{"name":"ignorePreferredRoutes","in":"query","required":false,"schema":{"type":"string"}},{"name":"avoidTurns","in":"query","required":false,"schema":{"type":"string"}},{"name":"ignoreZeroSpeedPoints","in":"query","required":false,"schema":{"type":"string"}},{"name":"wpDist","in":"query","required":false,"schema":{"type":"string"}},{"name":"connectorType","in":"query","required":false,"schema":{"type":"string"}},{"name":"failOnChargingStationGaps","in":"query","required":false,"schema":{"type":"string"}},{"name":"batteryParameters","in":"query","required":false,"schema":{"type":"string"}},{"name":"chargingStationFilters","in":"query","required":false,"schema":{"type":"string"}},{"name":"makeReachable","in":"query","required":false,"schema":{"type":"string"}},{"name":"cellularSignals","in":"query","required":false,"schema":{"type":"string"}},{"name":"plannedWaypointReachTolerance","in":"query","required":false,"schema":{"type":"string"}},{"name":"customRestrLimit","in":"query","required":false,"schema":{"type":"string"}},{"name":"evPoiLayer","in":"query","required":false,"schema":{"type":"string"}},{"name":"routeMatch2PlannedWayPointReachRadius","in":"query","required":false,"schema":{"type":"string"}},{"name":"detectSkippedPlannedWaypoint","in":"query","required":false,"schema":{"type":"string"}},{"name":"ignoreWaypointsFarFromNeighbors","in":"query","required":false,"schema":{"type":"string"}},{"name":"wayPointHeadingMismatchPenaltyFactor","in":"query","required":false,"schema":{"type":"string"}},{"name":"avoidPrivate","in":"query","required":false,"schema":{"type":"string"}},{"name":"licensePlate","in":"query","required":false,"schema":{"type":"string"}},{"name":"adminTruckRestrictions","in":"query","required":false,"schema":{"type":"string"}},{"name":"mapMatchTolerance","in":"query","required":false,"schema":{"type":"string"}},{"name":"privateChargingStation","in":"query","required":false,"schema":{"type":"string"}},{"name":"costPerConsumptionUnit","in":"query","required":false,"schema":{"type":"string"}},{"name":"restTimeDriverCost","in":"query","required":false,"schema":{"type":"string"}},{"name":"avoidFeatures","in":"query","required":false,"schema":{"type":"string"}},{"name":"ehorizonLimits","in":"query","required":false,"schema":{"type":"string"}},{"name":"truckVerified","in":"query","required":false,"schema":{"type":"string"}},{"name":"metricSystem","in":"query","required":false,"schema":{"type":"string"}},{"name":"avoidCountryChange","in":"query","required":false,"schema":{"type":"string"}},{"name":"trafficIncidents","in":"query","required":false,"schema":{"type":"string"}},{"name":"pathCoordinates","in":"query","required":false,"schema":{"type":"string"}},{"name":"followPath","in":"query","description":"Pass a sequence of link IDs defining the route path. Syntax: F: or L:LinkID0;LinkID1;...","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}],"responses":{"200":{"description":"OK","content":{"application/xml;charset=UTF-8":{"schema":{"type":"string"}},"multipart/form-data":{"schema":{"type":"string"}}}}}},"post":{"tags":["Routing Extensions & Route Matching"],"operationId":"calculateRouteXML_1","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"driver_cost","in":"query","required":false,"schema":{"type":"string"}},{"name":"vehicle_cost","in":"query","required":false,"schema":{"type":"string"}},{"name":"vehicleCostOnFerry","in":"query","required":false,"schema":{"type":"string"}},{"name":"currency","in":"query","required":false,"schema":{"type":"string"}},{"name":"region","in":"query","required":false,"schema":{"type":"string"}},{"name":"release","in":"query","required":false,"schema":{"type":"string"}},{"name":"departure","in":"query","required":false,"schema":{"type":"string"}},{"name":"tollVehicleType","in":"query","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","description":"0=None, 1=Caravan, 2=Trailer, 3=RVTrailer, 4=BoatTrailer. For toll cost and recreational vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","description":"Number of trailers, 0...4. For toll cost and truck restrictions. 0=no trailer, 1=one or more trailers, 2=two or more trailers, 3=three or more trailers. For truck restrictions: 4=one or more semi-trailers.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","description":"Number of axles excluding trailers. For toll cost and for country wide truck restrictions.
","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","description":"Number of trailer axles. For toll cost and for country wide truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","description":"1=fuel+electric, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","description":"1=EURO I, 2=EURO II, 3=EURO III, 4=EURO IV, 5=EURO V, 6=EURO VI, 7=EURO EEV, 8=Electric Vehicles, 9=EURO II with PRC, 10=EURO III with PRC. For toll cost and environmental zone restrictions, when emissionType is not specified it defaults to 5.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","description":"CO2 emission class of the vehicle. 1=Emission class 1, 2=Emission class 2, 3=Emission class 3, 4=Emission class 4, 5=Emission class 5. For toll cost only, when co2EmissionClass is not specified then it defaults to 1. Providing invalid combination of emissionType and co2EmissionClass in request may result in incorrect toll costs.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","description":"Actual height of the overall rigid/semi truck including trailers: 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","description":"Actual height of the trailer(s). 350cm or 3.5m or 138in. For toll cost only, not considered for route path creation (use height parameter)
(Not available for Waypoints Sequence).","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","description":"Actual total weight of vehicle incl. payload, but not trailers' weight or payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","description":"Actual total weight of vehicle incl. payload and trailers/caravan incl. their payload. 7.5t or 7500kg or 16500lbs. For truck restrictions, speed profile, toll cost and environmental zone restrictions. See also vehicleWeight. Note that country wide weight restrictions depend on the number of axles and trailers as well, so it might be necessary to specify them as well.","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Legal maximum weight limit of vehicle incl. payload and trailers. Also incl. their payload as a total. 7.5t or 7500kg or 16500lbs. For truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","description":"1=vehicle equipped to carry disabled people, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","description":"Actual number of passengers. For toll cost. See also vehicle type carHOV.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","description":"Number of tires. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","description":"1=vehicle registered for commercial use, 0=otherwise. For toll cost, environmental zone regulations and delivery-only zones.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","description":"Comma separated list from explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable. For toll cost (only explosive and other) and for truck restrictions. For Waypoints Sequence, allhazardousGoods and explosiveFlammable are not supported.","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","description":"350cm or 3.5m or 138in. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","description":"Length of the vehicle (including potential trailers). 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxle","in":"query","description":"Actual total weight per axle, incl. payload. 7.5t or 7500kg or 16500lbs (Waypoints Sequence in kg, no unit). For toll cost and truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"width","in":"query","description":"Width of the vehicle, e.g. 350cm or 3.5m or 138in. For truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"tunnelCategory","in":"query","description":"Defines the tunnel categories the truck must NOT use. B, C, D or E. A tunnels have no restrictions. E tunnels have most restrictions. If C is defined, the route will use A and B tunnels but not C, D or E.","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","description":"Defines the fuel powering the vehicle. Can be Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric. (LPG=Liquefied Petroleum Gas, LNG=Liquefied Natural Gas). Used f.e. for environmental zone restrictions, toll cost calculation, consumption based routing for Electric vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"weightPerAxleGroup","in":"query","description":"Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported names are drive, single, tandem, triple, quad, quint. Example: &weightPerAxleGroup=drive:12;single:11;tandem:18
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailerWeight","in":"query","description":"Actual total weight of trailers with their payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.","required":false,"schema":{"type":"string"}},{"name":"useTrafficPattern","in":"query","required":false,"schema":{"type":"string"}},{"name":"overlays","in":"query","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","required":false,"schema":{"type":"string"}},{"name":"algopts","in":"query","required":false,"schema":{"type":"string"}},{"name":"restTimes","in":"query","required":false,"schema":{"type":"string"}},{"name":"language","in":"query","required":false,"schema":{"type":"string"}},{"name":"avoidLinks","in":"query","required":false,"schema":{"type":"string"}},{"name":"avoidAreas","in":"query","required":false,"schema":{"type":"string"}},{"name":"arrival","in":"query","required":false,"schema":{"type":"string"}},{"name":"rollups","in":"query","required":false,"schema":{"type":"string"}},{"name":"jsonAttributes","in":"query","required":false,"schema":{"type":"string"}},{"name":"speedFcCat","in":"query","required":false,"schema":{"type":"string"}},{"name":"routeAttributes","in":"query","required":false,"schema":{"type":"string"}},{"name":"responseAttributes","in":"query","required":false,"schema":{"type":"string"}},{"name":"metaAttributes","in":"query","required":false,"schema":{"type":"string"}},{"name":"maneuverAttributes","in":"query","required":false,"schema":{"type":"string"}},{"name":"legAttributes","in":"query","required":false,"schema":{"type":"string"}},{"name":"linkAttributes","in":"query","required":false,"schema":{"type":"string"}},{"name":"learnIdSpeed","in":"query","required":false,"schema":{"type":"string"}},{"name":"learnStopsId","in":"query","required":false,"schema":{"type":"string"}},{"name":"learnedStopsId","in":"query","required":false,"schema":{"type":"string"}},{"name":"traverseGates","in":"query","required":false,"schema":{"type":"string"}},{"name":"routeMatch","in":"query","required":false,"schema":{"type":"string"}},{"name":"legal","in":"query","required":false,"schema":{"type":"string"}},{"name":"linkaccess","in":"query","required":false,"schema":{"type":"string"}},{"name":"attributes","in":"query","required":false,"schema":{"type":"string"}},{"name":"tollPass","in":"query","required":false,"schema":{"type":"string"}},{"name":"capacity","in":"query","required":false,"schema":{"type":"string"}},{"name":"customConsumptionDetails","in":"query","required":false,"schema":{"type":"string"}},{"name":"alternatives","in":"query","required":false,"schema":{"type":"string"}},{"name":"timeout","in":"query","required":false,"schema":{"type":"string"}},{"name":"ignoreWaypointVehicleRestriction","in":"query","required":false,"schema":{"type":"string"}},{"name":"maxSpeed","in":"query","required":false,"schema":{"type":"string"}},{"name":"alignToGpsTime","in":"query","required":false,"schema":{"type":"string"}},{"name":"customAttributes","in":"query","required":false,"schema":{"type":"string"}},{"name":"mapMatchRadius","in":"query","required":false,"schema":{"type":"string"}},{"name":"avoidCountry","in":"query","required":false,"schema":{"type":"string"}},{"name":"excludeZoneTypes","in":"query","required":false,"schema":{"type":"string"}},{"name":"preferMatchedVehicle","in":"query","required":false,"schema":{"type":"string"}},{"name":"requestId","in":"query","required":false,"schema":{"type":"string"}},{"name":"instructionFormat","in":"query","required":false,"schema":{"type":"string"}},{"name":"oneway","in":"query","required":false,"schema":{"type":"string"}},{"name":"drivingReport","in":"query","required":false,"schema":{"type":"string"}},{"name":"ignorePreferredRoutes","in":"query","required":false,"schema":{"type":"string"}},{"name":"avoidTurns","in":"query","required":false,"schema":{"type":"string"}},{"name":"ignoreZeroSpeedPoints","in":"query","required":false,"schema":{"type":"string"}},{"name":"wpDist","in":"query","required":false,"schema":{"type":"string"}},{"name":"connectorType","in":"query","required":false,"schema":{"type":"string"}},{"name":"failOnChargingStationGaps","in":"query","required":false,"schema":{"type":"string"}},{"name":"batteryParameters","in":"query","required":false,"schema":{"type":"string"}},{"name":"chargingStationFilters","in":"query","required":false,"schema":{"type":"string"}},{"name":"makeReachable","in":"query","required":false,"schema":{"type":"string"}},{"name":"cellularSignals","in":"query","required":false,"schema":{"type":"string"}},{"name":"plannedWaypointReachTolerance","in":"query","required":false,"schema":{"type":"string"}},{"name":"customRestrLimit","in":"query","required":false,"schema":{"type":"string"}},{"name":"evPoiLayer","in":"query","required":false,"schema":{"type":"string"}},{"name":"routeMatch2PlannedWayPointReachRadius","in":"query","required":false,"schema":{"type":"string"}},{"name":"detectSkippedPlannedWaypoint","in":"query","required":false,"schema":{"type":"string"}},{"name":"ignoreWaypointsFarFromNeighbors","in":"query","required":false,"schema":{"type":"string"}},{"name":"wayPointHeadingMismatchPenaltyFactor","in":"query","required":false,"schema":{"type":"string"}},{"name":"avoidPrivate","in":"query","required":false,"schema":{"type":"string"}},{"name":"licensePlate","in":"query","required":false,"schema":{"type":"string"}},{"name":"adminTruckRestrictions","in":"query","required":false,"schema":{"type":"string"}},{"name":"mapMatchTolerance","in":"query","required":false,"schema":{"type":"string"}},{"name":"privateChargingStation","in":"query","required":false,"schema":{"type":"string"}},{"name":"costPerConsumptionUnit","in":"query","required":false,"schema":{"type":"string"}},{"name":"restTimeDriverCost","in":"query","required":false,"schema":{"type":"string"}},{"name":"avoidFeatures","in":"query","required":false,"schema":{"type":"string"}},{"name":"ehorizonLimits","in":"query","required":false,"schema":{"type":"string"}},{"name":"truckVerified","in":"query","required":false,"schema":{"type":"string"}},{"name":"metricSystem","in":"query","required":false,"schema":{"type":"string"}},{"name":"avoidCountryChange","in":"query","required":false,"schema":{"type":"string"}},{"name":"trafficIncidents","in":"query","required":false,"schema":{"type":"string"}},{"name":"pathCoordinates","in":"query","required":false,"schema":{"type":"string"}},{"name":"followPath","in":"query","description":"Pass a sequence of link IDs defining the route path. Syntax: F: or L:LinkID0;LinkID1;...","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/xml;charset=UTF-8":{"schema":{"type":"string"}},"multipart/form-data":{"schema":{"type":"string"}}}}}}},"/2/calculateroute.json":{"get":{"tags":["Routing Extensions & Route Matching"],"summary":"Calculates a route with additional fleet telematics features","description":"Calculates a route with additional fleet telematics features.\r\nThis resource provides a similar interface as the Routing REST API.\r\nNote: If using the cre.api.here.com endpoint, then requests that don't need specific features may get redirected to the Routing REST API. This doesn't happen when using the fleet.api.here.com endpoint.","operationId":"calculateRoute","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"driver_cost","in":"query","description":"Cost per hour in target currency.","required":false,"schema":{"type":"string"}},{"name":"vehicle_cost","in":"query","description":"Cost per kilometer in target currency.","required":false,"schema":{"type":"string"}},{"name":"vehicleCostOnFerry","in":"query","description":"Cost per kilometer on ferry in target currency. Default = vehicle_cost.","required":false,"schema":{"type":"string"}},{"name":"currency","in":"query","description":"3 letter ISO currency symbol, like EUR or USD. Required if toll cost must be added up across different currencies and/or be added to driver/vehicle/fuel cost in different currencies.","required":false,"schema":{"type":"string"}},{"name":"region","in":"query","description":"Optional (default=whole world excl. JPN, CHN, SK). Map coverage region, e.g. APAC, AUS, WEU, IND, MEA, NA, SAM, TWN, JPN. The region may contain hints to distinguish specific content. E.g. there can be an WEU and PCBEU, where the 2nd map contains only Postal Code Boundary layers. If not specified, the service will find the region(s) automatically, that cover the request. The parameter can contain a comma separated list of regions (f.e. WEU,MEA). If the region parameter is specified, the service will use these region(s) and skip region(s) that may also cover the response (f.e. EEU). Except of JPN, specifying a region is strongly discouraged, because regions might change and hence applications that specify a region might stop working when the region gets discontinued, renamed, split or changed otherwise. As the APAC region contains a simplified entry map content of JPN, JPN needs to be specified as region to access the full JPN content.","required":false,"schema":{"type":"string"}},{"name":"departure","in":"query","description":"Format: now, yyyy-MM-dd'T'HH:mm:ss or yyyy-MM-dd'T'HH:mm:ssX. If no timezone is specified, then the local timezone at the route start link is used. Default: Ignore all time dependent access restrictions. Special values: ignoreTimeDepRestr (like default), obeyTimeDepRestr (all time dependent restrictions apply).","required":false,"schema":{"type":"string"}},{"name":"tollVehicleType","in":"query","description":"1=Motorcycle, 2=Auto, 3=Truck, 4=Motor home, 5=Minibus, 6=Bus, 7=Motorcycle Sidecar(EU), 8=Tricycle(EU), 9=Delivery Truck(EU+India), 10=Snowmobile(US), 11=Pick-up(US+India), 12=Tractor(US+India), 13=Taxi, 14=HCM/EME (India Heavy Construction Machinery/Earth Moving Equipment)","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","description":"0=None, 1=Caravan, 2=Trailer, 3=RVTrailer, 4=BoatTrailer. For toll cost and recreational vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","description":"Number of trailers, 0...4. For toll cost and truck restrictions. 0=no trailer, 1=one or more trailers, 2=two or more trailers, 3=three or more trailers. For truck restrictions: 4=one or more semi-trailers.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","description":"Number of axles excluding trailers. For toll cost and for country wide truck restrictions.
","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","description":"Number of trailer axles. For toll cost and for country wide truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","description":"1=fuel+electric, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","description":"1=EURO I, 2=EURO II, 3=EURO III, 4=EURO IV, 5=EURO V, 6=EURO VI, 7=EURO EEV, 8=Electric Vehicles, 9=EURO II with PRC, 10=EURO III with PRC. For toll cost and environmental zone restrictions, when emissionType is not specified it defaults to 5.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","description":"CO2 emission class of the vehicle. 1=Emission class 1, 2=Emission class 2, 3=Emission class 3, 4=Emission class 4, 5=Emission class 5. For toll cost only, when co2EmissionClass is not specified then it defaults to 1. Providing invalid combination of emissionType and co2EmissionClass in request may result in incorrect toll costs.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","description":"Actual height of the overall rigid/semi truck including trailers: 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","description":"Actual height of the trailer(s). 350cm or 3.5m or 138in. For toll cost only, not considered for route path creation (use height parameter)
(Not available for Waypoints Sequence).","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","description":"Actual total weight of vehicle incl. payload, but not trailers' weight or payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","description":"Actual total weight of vehicle incl. payload and trailers/caravan incl. their payload. 7.5t or 7500kg or 16500lbs. For truck restrictions, speed profile, toll cost and environmental zone restrictions. See also vehicleWeight. Note that country wide weight restrictions depend on the number of axles and trailers as well, so it might be necessary to specify them as well.","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Legal maximum weight limit of vehicle incl. payload and trailers. Also incl. their payload as a total. 7.5t or 7500kg or 16500lbs. For truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","description":"1=vehicle equipped to carry disabled people, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","description":"Actual number of passengers. For toll cost. See also vehicle type carHOV.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","description":"Number of tires. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","description":"1=vehicle registered for commercial use, 0=otherwise. For toll cost, environmental zone regulations and delivery-only zones.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","description":"Comma separated list from explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable. For toll cost (only explosive and other) and for truck restrictions. For Waypoints Sequence, allhazardousGoods and explosiveFlammable are not supported.","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","description":"350cm or 3.5m or 138in. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","description":"Length of the vehicle (including potential trailers). 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxle","in":"query","description":"Actual total weight per axle, incl. payload. 7.5t or 7500kg or 16500lbs (Waypoints Sequence in kg, no unit). For toll cost and truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"width","in":"query","description":"Width of the vehicle, e.g. 350cm or 3.5m or 138in. For truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"tunnelCategory","in":"query","description":"Defines the tunnel categories the truck must NOT use. B, C, D or E. A tunnels have no restrictions. E tunnels have most restrictions. If C is defined, the route will use A and B tunnels but not C, D or E.","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","description":"Defines the fuel powering the vehicle. Can be Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric. (LPG=Liquefied Petroleum Gas, LNG=Liquefied Natural Gas). Used f.e. for environmental zone restrictions, toll cost calculation, consumption based routing for Electric vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"weightPerAxleGroup","in":"query","description":"Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported names are drive, single, tandem, triple, quad, quint. Example: &weightPerAxleGroup=drive:12;single:11;tandem:18
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailerWeight","in":"query","description":"Actual total weight of trailers with their payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.","required":false,"schema":{"type":"string"}},{"name":"overlays","in":"query","description":"Overlay map name. Case insensitive. Must start with OVERLAY and contain only characters.","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"fastest;car;traffic:disabled;[optional parameters] As optional parameters motorway (0, -1, -2, -3), tollroad (0, -1, -2, -3), boatFerry (0, -1, -2, -3), railFerry (0, -1, -2, -3), and tunnel (0, -1, -2, -3) can follow. \"shortest\" and \"balanced\" are not supported but can be individually tuned using &driver_cost and &vehicle_cost. Vehicle types: bdouble, bicycle, bus, car, carHOV, custom1, emergency, motorcycle, pedestrian, roadtrain, taxi, truck, motorhome","required":false,"schema":{"type":"string"}},{"name":"restTimes","in":"query","description":"Legal drive/rest intervals. Specify 'local' to obey the legal driver rest times of the respective country. Alternatively, proprietary values can be set for DriveTimeUntilShortBreak, ElapsedTimeUntilShortBreak, ShortBreakDuration, DriveTimeUntilLongRest, ElapsedTimeUntilLongBreak, LongRestDuration. E.g. EU requires after 4.5h a 45min break + after 9h an 11h rest. If the driver is not fresh then add ,TimeAlreadyDrivenSinceLastShortBreak, ElapsedTimeSinceLastShortBreak, TimeAlreadyDrivenSinceLastLongRest, ElapsedTimeSinceLastLongRest in seconds. Specify ;earlierRestTimeFactor:0.0 to take rest times much earlier to reduce travel time (arriving with less legal driving time left), default = 0.75","required":false,"schema":{"type":"string"}},{"name":"language","in":"query","description":"Language for the maneuver instructions in the response. Currently de-de, en-us, it-it, fr-fr, es-es, pt-pt, pl-pl, cs-cs, zh-cn, zh-tw, zh-hk and ja-jp are supported. If not specified, en-us is used.","required":false,"schema":{"type":"string"}},{"name":"avoidLinks","in":"query","description":"Comma separated list of link ids or lat,lon[;heading] coordinates to be avoided. Positive ids are not driven from reference node, negative ids are not driven towards reference node. Use '*' prefix to avoid both directions. For coordinates direction of blocking depends on the heading. If no heading given both directions will be avoided. Optionally an entry penalty (applied once while entering the sequence of link(s)) and drive penalty (applied to every link) can be specified individually for each link to be avoided, format: 'linkId[;penalty:entryPenaltySec[:drivePenaltyFactor]] or lat,lon[;penalty:entryPenaltySec[:drivePenaltyFactor]]'. entryPenalty should be between -120 and 600 (-ve penalty implies prefer), drivePenaltyFactor should be between 0.1 and 20.0 (1.0 implies no penalty, < 1.0 implies prefer). e.g. 1308094486;penalty:60:1.5,-1308094485;penalty:2:2.5 .","required":false,"schema":{"type":"string"}},{"name":"avoidAreas","in":"query","description":"List of areas (rectangles or polygons) to be avoided. Areas are separated by '!'. Rectangles can be specified with two diagonal coordinates separated by ';', e.g. latMax,lonMin;latMin,lonMax. Polygons are specified with consecutive vertex coordinates separated by ';', e.g. lat1,lon1;lat2,lon2;lat3,lon3;... . Optionally an entry penalty (applied once while entering the area) and drive penalty (applied to every link driven inside the area) can be specified individually for each area to be avoided, format: 'polygon1Coords[;penalty:entryPenaltySec[,drivePenaltyFactor]]!polygon2Coords[;penalty:entryPenaltySec[,drivePenaltyFactor]]'. entryPenalty should be between -120 and 600 (-ve penalty implies prefer), drivePenaltyFactor should be between 0.1 and 20.0 (1.0 implies no penalty, < 1.0 implies prefer). e.g. poly1lat1,poly1lon1,poly1lat2,poly1lon2,poly1lat3,poly1lon3;penalty:60,1.5!poly2lat1,poly2lon1,poly2lat2,poly2lon2,poly2lat3,poly2lon3;penalty:-100,0.5 .","required":false,"schema":{"type":"string"}},{"name":"arrival","in":"query","description":"Format like departure. Use this to find out when you have to start the journey to arrive at the given time. Note that toll cost is not considered when arrival time is specified.","required":false,"schema":{"type":"string"}},{"name":"rollups","in":"query","description":"Comma separated list of rollups (groupings, aggregation levels) in the result. Currently supported rollups are none (per link details), total (totals), tollsys (per toll system summaries), country (per country summaries), country;tollsys (per country and toll system summaries). Example: &rollups=none,country;tollsys,country returns the cost details and 2 different summaries.","required":false,"schema":{"type":"string"}},{"name":"speedFcCat","in":"query","description":"Comma separated list of speeds driven in kilometer per hour per road functional class (1-5 + Virtual Connections VC) and speed category (1-8) (f.e. FC1-SC1,FC1-SC2,...,FC1-SC8;FC2-SC1,FC2-SC2,...;...;VC-SC1,FC-SC2,...VC-SC8). Functional classes are semicolon separated. Can contain empty entries (no change to default f.e. 80,76,,,,,,;,,,54,46,,,;...). Overrides router's default driven speed values. Also one of the predefined profiles can be activated by value car, light-truck, medium-truck or heavy-truck","required":false,"schema":{"type":"string"}},{"name":"routeAttributes","in":"query","description":"Defines which information is included in the response route part of the calculated route. Defaults to mode (mo), waypoints (wp), summary (sm), flags (fl). Also supported: speedProfile (sp), shape (sh), summaryByCountry (sc), boundingBox (bb), none. Can be excluded in the response by putting a hyphen in the front. e.g. -wp","required":false,"schema":{"type":"string"}},{"name":"responseAttributes","in":"query","description":"Defines which information is included in the response as part of the calculated route. Defaults to warnings (wn). Also supported: language (lg), none. Can be excluded in the response by putting a hyphen in the front. e.g. -wn","required":false,"schema":{"type":"string"}},{"name":"metaAttributes","in":"query","description":"Defines which information is included in the meta part of the calculated route. Defaults to none. Also supported: version (ver), coverage (cov). Can be excluded in the response by putting a hyphen in the front. e.g. -ver","required":false,"schema":{"type":"string"}},{"name":"maneuverAttributes","in":"query","description":"Defines which information is included in the response as part of the data representation of the route maneuvers. Defaults to position (po), length (le), travelTime (tt). Also supported: direction (di), action (ac), indices (ix), lanes (ln), roadName(rn), nextRoadName (nr), beforeAfter (ba) and none.","required":false,"schema":{"type":"string"}},{"name":"legAttributes","in":"query","description":"Defines which information is included in the response as part of the route legs. Defaults to links (li), maneuvers (mn), length (le), travelTime (tt), baseTime (bt), trafficTime (tm). Also supported: shape (sh), boundingBox (bb), turnbyturnmaneuvers (mm), none. Can be excluded in the response by putting a hyphen in the front. e.g. -mn. Also in RouteMatch mode legAttributes=mn is supported.","required":false,"schema":{"type":"string"}},{"name":"linkAttributes","in":"query","description":"Define optional attributes to be returned for each link. Defaults to shape (sh), length (le), remainTime (rt), remainDistance (rd), functionalClass (fc), warnings (wn), confidence (cd). Also supported: cost (co), maneuver (ma), timezone (tz), none. Can be excluded in the response by putting a hyphen in the front. e.g. -ma","required":false,"schema":{"type":"string"}},{"name":"learnStopsId","in":"query","description":"Identifier of a profile to learn stop characteristics. Profiles can be defined arbitrarily, e.g by driver, vehicle, departure time or a combination of them. Parameter is used to learn while route matching. Cannot be used together with learnedStopsId.","required":false,"schema":{"type":"string"}},{"name":"learnedStopsId","in":"query","description":"Identifier of a profile to use stop characteristics. Profiles can be defined arbitrarily, e.g by driver, vehicle, departure time or a combination of them. Parameter is to apply learnings while routing. Cannot be used together with learnStopsId.","required":false,"schema":{"type":"string"}},{"name":"traverseGates","in":"query","description":"Assume the driver has keys/permissions to traverse gates, if \"true\". Accepted values are either \"true\" or \"airlineDistanceInMeters,entryPenaltyInSec\". Default = don't traverse any gates unless vehicle type is emergency.","required":false,"schema":{"type":"string"}},{"name":"routeMatch","in":"query","description":"Default: Compute a legal route that goes through all way points. 1 = treat the waypoints (or trace file POST body) as GPS trace and return the most probable route along this trace. 2 = ETA Tracking mode, compute the route and take the POST body GPS trace into account to detect taken driver rest times and reached/skipped waypoints. To get maneuvers for a matched route specify &legAttributes=mn.","required":false,"schema":{"type":"string"}},{"name":"legal","in":"query","description":"For routeMatch=1. Enforces a legal route w.r.t. the listed maneuver types. Support maneuver types (comma separated list): access,gate,oneway,thrutraf,turn. Passing all of them yields a legal route as from a router. access=use only links allowed for the vehicle type (incl. truck measures). gate=don't traverse gates. oneway=don't drive links into forbidden direction. thrutraf=don't enter+leaving 'no through traffic' zones. turn=don't turn/u-turn illegally. Default: avoid illegal maneuvers, but use them if the trace obviously used them. If used, return respective warnings.","required":false,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"Comma separated list of PDE layer names, to get link attributes along the route. Only link attribute layers (roughly those ending in _FC1, _FC2 ... ) are supported. Specify FCn to get the layers of all functional classes. Behind each layer name attributes can be listed, or (*) to get all. Example: &attributes=ROAD_GEOM_FCn(TUNNEL), SPEED_LIMITS_FCn (FROM_REF_SPEED_LIMIT, TO_REF_SPEED_LIMIT), ADAS_ATTRIB_FCn (SLOPES). A maximum of 32 layers can be requested per request.","required":false,"schema":{"type":"string"}},{"name":"tollPass","in":"query","description":"Comma separated list of owned passes: Senior_Pass, transponder (the car has all transponders), noTransponder (have no transponder and use no system that requires one), allPasses, Annual, Nr_of_Days, Nr_of_Months (meaning the car has all passes valid for this number of months), AutoPass, SunPass, E-Z Pass (last 2 are examples for real toll transponders). Can also list toll system ids or toll booth condition ids. Allows traversal of 'transponder-only' toll booths, allows cost free traversal of certain toll sections and allows using cheaper prices for transponder/pass owners.","required":false,"schema":{"type":"string"}},{"name":"capacity","in":"query","description":"Comma separated list of numeric truck capacity limits. E.g. 8,25,6 for max. 8t payload and max. 25 square meter floor space and max 6 passengers. Must match the 'load' values of way points. For unsorted or optional way points.","required":false,"schema":{"type":"string"}},{"name":"customConsumptionDetails","in":"query","description":"Semicolon separated list of speed/ascent/descent/builtupFactor/auxilliaryConsumption fuel consumption parameters. Speed is a list of $/km for different speeds. Ascent/descent are additional $/km per altitude climbed or descended. Builtup factor is an optional heuristic consumption multiplier for urban area, default value is 1.55. auxilliaryConsumption is the additional consumption (per hour) for running auxilliary units (climate control, infotainment, lights, etc.). Cost unit is not $ but 'currency'. Example: speed,0,0.102,10,0.084,30,0.066,50,0.06,70,0.066,100,0.072,120,0.084,140,0.108; ascent,0.4; descent,0.1; builtupFactor,1.4 = at 70 kph the car consumes 6.6$/100km and 0.4$/km altitude climbed, consumption increases 40% in urban area. Alternatively, user can specify default consumption profile: 3.5t, 7.5t, 18t, 40t or weightDependent. In case of the weightDependent consumption profiles will be decided based on the limitedWeight so this parameter also needs to be specified.","required":false,"schema":{"type":"string"}},{"name":"alternatives","in":"query","description":"Maximum number of alternative route options to return. Can return less or no alternatives. Only returns route alternatives that significantly differ from the best route but are not much more costly.","required":false,"schema":{"type":"string"}},{"name":"timeout","in":"query","description":"Routing calculation must be finished within this amount of milliseconds. Default 50000. Maximum 50000.","required":false,"schema":{"type":"string"}},{"name":"ignoreWaypointVehicleRestriction","in":"query","description":"Format: radius[;drivePenaltyFactor[;type[;entryPenalty]]]. radius: in meters around a waypoint to ignore various vehicle restrictions (vehicle type, admin truck, time-based, construction closed) if necessary. drivePenaltyFactor: (cost multiplier 0...1) to control how strict to avoid restrictions. type: restrictions types (time based restrictions/all permanent restriction/construction status) to be ignored, accepted values are: all,allTimed,construction. entryPenalty: penalty in seconds (0....7200) applied once while ignoring each restriction type (like entering a 'no through traffic' or entering a 'admin truck restricted' area), default - 3600 (1 hour). Example1: ignoreWaypointVehicleRestriction=2000. Example2: ignoreWaypointVehicleRestriction=2000;;allTimed . Example3: ignoreWaypointVehicleRestriction=5000;0.9;construction,all;1800 .","required":false,"schema":{"type":"string"}},{"name":"maxSpeed","in":"query","description":"Maximum speed allowed for the whole routing. Supported units are kmh (kilometres per hour), mph (miles per hour) and mps (metres per second). If no unit is provided, kmh will be used as default unit.","required":false,"schema":{"type":"string"}},{"name":"alignToGpsTime","in":"query","description":"Route matching tries to align the driving time to the GPS timestamps. On per default. Set to 0 to switch it off.","required":false,"schema":{"type":"string"}},{"name":"customAttributes","in":"query","description":"Comma separated list of CLE layer names, to get link attributes along the route. Format follows the 'attribute' parameter. No FCn notation supported","required":false,"schema":{"type":"string"}},{"name":"mapMatchRadius","in":"query","description":"Maximum adaptive map match search radius [meter]. Will be applied to each way point. If given it overrides waypoints' transitRadius values and the default maximum adaptive search radius. For routing, default 1600. Limit 5000.","required":false,"schema":{"type":"string"}},{"name":"excludeCountries","in":"query","required":false,"schema":{"type":"string"}},{"name":"excludeZoneTypes","in":"query","description":"Checks if a route may enter a zone. Currently supported values: environmental,vignette and congestionPricing. If omitted or empty, zone restrictions are not taken into account. Not supported for route matching.","required":false,"schema":{"type":"string"}},{"name":"requestId","in":"query","description":"Mirrored RequestId value from the request structure. Used to trace requests.","required":false,"schema":{"type":"string"}},{"name":"instructionFormat","in":"query","description":"Defines the representation format of the maneuver's instruction text. Supported formats are text|html","required":false,"schema":{"type":"string"}},{"name":"oneway","in":"query","description":"Default: Obey oneways. 'penalty:0.5' allows oneway violation if the time benefit is more than 0.5 sec/meter. For bicycle recommended value 0.125, for emergencies 0.5. Not allowed for other vehicles.","required":false,"schema":{"type":"string"}},{"name":"drivingReport","in":"query","description":"Defines whether driving report is added to the route match response. Set to 1 to switch it on. Turned off by default.","required":false,"schema":{"type":"string"}},{"name":"ignorePreferredRoutes","in":"query","description":"Preferred routes for a specific vehicle type, are taken by default. To turn if off set ignorePreferredRoutes to true.","required":false,"schema":{"type":"string"}},{"name":"avoidTurns","in":"query","description":"Comma separated list of elements like left[;minAngleDegree;penaltySec] or right... or uTurn[;penaltySec] if a left/right turn is sharper than the specified angle (0...180) then the given time penalty is applied. uTurnAtWaypoint avoids u-turning on the link directly where the waypoint was reached.","required":false,"schema":{"type":"string"}},{"name":"ignoreZeroSpeedPoints","in":"query","description":"Only for route matching. Default = consider all points. 1 = ignore trace points that have zero speed (only in traces that provide speed but not time).","required":false,"schema":{"type":"string"}},{"name":"wpDist","in":"query","description":"Only for route matching. 0 = default value, feature is disabled. 1 = return spatial distance between matched trace points. 2 = return spatial distance between original trace points","required":false,"schema":{"type":"string"}},{"name":"chargingStationFilters","in":"query","description":"URL Encoded comma separated list of charging stations to filter out the electric vehicle charging stations, along the route.","required":false,"schema":{"type":"string"}},{"name":"makeReachable","in":"query","description":"A route will be returned even there are not sufficient fuel/EV-charging stations along the route consumption/energy details if this parameter is set to true. Default = false.","required":false,"schema":{"type":"string"}},{"name":"cellularSignals","in":"query","required":false,"schema":{"type":"string"}},{"name":"plannedWaypointReachTolerance","in":"query","description":"Only for routeMatch=2 with learned stops. Default = 20000 meter. If the trace gets closer then the learned stop is considered reached","required":false,"schema":{"type":"string"}},{"name":"customRestrLimit","in":"query","description":"Comma separated list of key value pairs of custom restriction limits. The key and value of individual custom restriction limit must be numeric and must be separated by colon. Example: 0:10,1:20,2:50","required":false,"schema":{"type":"string"}},{"name":"evPoiLayer","in":"query","description":"Name of the layer which will be used to find the Electric Charging Stations along the route for Electric Vehicle Routing","required":false,"schema":{"type":"string"}},{"name":"routeMatch2PlannedWayPointReachRadius","in":"query","description":"Only for routeMatch=2. If vehicle approaches a planned waypoint closer than this then the waypoint is considered reached. Default 20000.0m.","required":false,"schema":{"type":"string"}},{"name":"detectSkippedPlannedWaypoint","in":"query","description":"Only for routeMatch=2. Default to true. This flag enables/disables the logic to analyze the GPS trace and determines which planned waypoints are skipped. You can prevent waypoint skipping by setting this value to false.","required":false,"schema":{"type":"string"}},{"name":"ignoreWaypointsFarFromNeighbors","in":"query","description":"Only for routeMatch> 0. Default true. If false then doesn't ignore a trace point when it is much further away from its neighbors than the usual distances in the trace","required":false,"schema":{"type":"string"}},{"name":"wayPointHeadingMismatchPenaltyFactor","in":"query","description":"Tie waypoints closer to links where the GPS heading matches the link's heading, and try harder to meet waypoints in the given driving direction. Default = 1.","required":false,"schema":{"type":"string"}},{"name":"avoidPrivate","in":"query","description":"Use private streets for routing. Set to 1 to always allow it or -1 to always forbid it. Default is 0 - access is allowed if there is a waypoint in the private street.","required":false,"schema":{"type":"string"}},{"name":"licensePlate","in":"query","description":"Licenseplate of the vehicle. The vehicles registration number can influence the permission to drive in certain zones, mostly environmental zones. For enhanced privacy, irrelevant license plate letters/digits can be dummy values.","required":false,"schema":{"type":"string"}},{"name":"adminTruckRestrictions","in":"query","description":"Per default admin wide truck restrictions are obeyed. 'ignore' ignores them.","required":false,"schema":{"type":"string"}},{"name":"mapMatchTolerance","in":"query","description":"Map match tolerance [meter]. Will be applied to each way point. Routing can meet the waypoint on all links that are that much further away from the coordinate than the nearest. Default 3.0.","required":false,"schema":{"type":"string"}},{"name":"privateChargingStation","in":"query","description":"If true then private charging stations will be considered during routing. Default is false.","required":false,"schema":{"type":"string"}},{"name":"costPerConsumptionUnit","in":"query","description":"The cost of a consumption unit in targetCurrency. Default is 1.","required":false,"schema":{"type":"string"}},{"name":"restTimeDriverCost","in":"query","description":"Cost per hour in target currency while driver is taking a legal rest time. Can be between 0 and driver_cost value.","required":false,"schema":{"type":"string"}},{"name":"avoidFeatures","in":"query","description":"Comma separated list of road features to be avoided. Currently supported: unpaved[;300;50]. Avoids unpaved roads by the specified seconds to enter (Entry penalty) and seconds/km driven (drive penalty), or a default penalty","required":false,"schema":{"type":"string"}},{"name":"truckVerified","in":"query","description":"Make use of truck verified roads for truck routing. 1 prefers transport verified roads, 0 uses verified and non verified without preference.","required":false,"schema":{"type":"string"}},{"name":"metricSystem","in":"query","description":"Set to 'imperial' to receive guidance instruction distances in miles. Default = metric.","required":false,"schema":{"type":"string"}},{"name":"avoidCountryChange","in":"query","description":"Penalties in seconds to avoid unnecessary waiting time on border crossings. Countries should be specified according to 3 character ISO 3166 standard. A comma should be used to separate the multiple avoidChangeCountry on the route. Format: Country code1-Country code2:Penalty in seconds[,Country code1-Country code2:Penalty in seconds]","required":false,"schema":{"type":"string"}},{"name":"trafficIncidents","in":"query","description":"Set 'true'/'false' to enable/disable usage of traffic incidents (road blocks) during route estimation for the complete length of route, default is 'false' - traffic incidents are disabled. Usage of traffic incidents will impact the routing response time, use only if necessary.","required":false,"schema":{"type":"string"}},{"name":"pathCoordinates","in":"query","description":"Set 1 to get a minimum sequence of coordinates back that you can send to any router to enforce exactly this route. Default 0. Only for route matching, enabled by routeMatch=1. Returns a coordinate after each junction (if a minimum distance traveled since previous). This distance is by default 50m and can be changed by sub-parameter minDist:","required":false,"schema":{"type":"string"}},{"name":"followPath","in":"query","description":"Pass a sequence of link IDs defining the route path. Syntax: F: or L:LinkID0;LinkID1;...","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"waypoint0 ... waypointN","in":"query","description":"Comma separated waypoint latitude, longitude in WGS-84 degree. The coordinates may be directly followed by ;transitRadius;label;heading[;optional specifications]. \r\nA route must consist of at least 2 waypoints (start and destination). The coordinates may be directly followed by ;transitRadius;label;heading. \r\nThe maximum number of waypoints is limited. However, this limit is not a fixed number but is a result of the limit for the overall processing time. \r\nSet a transit radius to only influence the route to go via a certain city (Example: &waypoint1=50.12,8.65;10000). \r\nSet a heading (degree clockwise from North) to improve map matching (Example: latitude,longitude;;;140). \r\nTo define a loading time or delay time at a waypoint, use stopOver[,timeInSeconds]! (Example: &waypoint1=stopOver,300!50.12,8.65). \r\nThe optional specifications altitude, custom label, !StreetPosition and !LinkPosition, ignoreRestriction are currently supported.\r\nTo define a radius around the waypoint where vehicle restrictions should be ignored use optional specification ';ignoreRestriction:radius[,drivePenalty[,type[,entryPenalty]]]. Example: &waypoint1=50.12,8.65;ignoreRestriction:8000,0.9,all,1800 . \r\nThis is similar to the global parameter 'ignoreWaypointVehicleRestriction' which applies to all waypoint. But when specified explicitly for a waypoint, the 'ignoreRestriction' specification of waypoint is applied. \r\nWaypoints can have opening and closing times, can be unsorted or optional. Details are in Key Concepts / Waypoint sorting, optional Pickup and Opening Times","required":true,"schema":{"type":"string"}},{"name":"file","in":"query","description":"Trace file for route matching. GPX, NMEA, KML, CSV or AGORA-C.","required":true,"style":"form","schema":{"type":"string","format":"binary"}},{"name":"jsonCallback","in":"query","description":"Specifies the function used to wrap the JSON response","schema":{"type":"string"}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/Response"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Response"}}}}}},"post":{"tags":["Routing Extensions & Route Matching"],"summary":"Calculates a route with additional fleet telematics features","description":"Calculates a route with additional fleet telematics features.\r\nThis resource provides a similar interface as the Routing REST API.\r\nNote: If using the cre.api.here.com endpoint, then requests that don't need specific features may get redirected to the Routing REST API. This doesn't happen when using the fleet.api.here.com endpoint.","operationId":"calculateRoute_1","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"driver_cost","in":"query","description":"Cost per hour in target currency.","required":false,"schema":{"type":"string"}},{"name":"vehicle_cost","in":"query","description":"Cost per kilometer in target currency.","required":false,"schema":{"type":"string"}},{"name":"vehicleCostOnFerry","in":"query","description":"Cost per kilometer on ferry in target currency. Default = vehicle_cost.","required":false,"schema":{"type":"string"}},{"name":"currency","in":"query","description":"3 letter ISO currency symbol, like EUR or USD. Required if toll cost must be added up across different currencies and/or be added to driver/vehicle/fuel cost in different currencies.","required":false,"schema":{"type":"string"}},{"name":"region","in":"query","description":"Optional (default=whole world excl. JPN, CHN, SK). Map coverage region, e.g. APAC, AUS, WEU, IND, MEA, NA, SAM, TWN, JPN. The region may contain hints to distinguish specific content. E.g. there can be an WEU and PCBEU, where the 2nd map contains only Postal Code Boundary layers. If not specified, the service will find the region(s) automatically, that cover the request. The parameter can contain a comma separated list of regions (f.e. WEU,MEA). If the region parameter is specified, the service will use these region(s) and skip region(s) that may also cover the response (f.e. EEU). Except of JPN, specifying a region is strongly discouraged, because regions might change and hence applications that specify a region might stop working when the region gets discontinued, renamed, split or changed otherwise. As the APAC region contains a simplified entry map content of JPN, JPN needs to be specified as region to access the full JPN content.","required":false,"schema":{"type":"string"}},{"name":"departure","in":"query","description":"Format: now, yyyy-MM-dd'T'HH:mm:ss or yyyy-MM-dd'T'HH:mm:ssX. If no timezone is specified, then the local timezone at the route start link is used. Default: Ignore all time dependent access restrictions. Special values: ignoreTimeDepRestr (like default), obeyTimeDepRestr (all time dependent restrictions apply).","required":false,"schema":{"type":"string"}},{"name":"tollVehicleType","in":"query","description":"1=Motorcycle, 2=Auto, 3=Truck, 4=Motor home, 5=Minibus, 6=Bus, 7=Motorcycle Sidecar(EU), 8=Tricycle(EU), 9=Delivery Truck(EU+India), 10=Snowmobile(US), 11=Pick-up(US+India), 12=Tractor(US+India), 13=Taxi, 14=HCM/EME (India Heavy Construction Machinery/Earth Moving Equipment)","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","description":"0=None, 1=Caravan, 2=Trailer, 3=RVTrailer, 4=BoatTrailer. For toll cost and recreational vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","description":"Number of trailers, 0...4. For toll cost and truck restrictions. 0=no trailer, 1=one or more trailers, 2=two or more trailers, 3=three or more trailers. For truck restrictions: 4=one or more semi-trailers.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","description":"Number of axles excluding trailers. For toll cost and for country wide truck restrictions.
","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","description":"Number of trailer axles. For toll cost and for country wide truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","description":"1=fuel+electric, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","description":"1=EURO I, 2=EURO II, 3=EURO III, 4=EURO IV, 5=EURO V, 6=EURO VI, 7=EURO EEV, 8=Electric Vehicles, 9=EURO II with PRC, 10=EURO III with PRC. For toll cost and environmental zone restrictions, when emissionType is not specified it defaults to 5.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","description":"CO2 emission class of the vehicle. 1=Emission class 1, 2=Emission class 2, 3=Emission class 3, 4=Emission class 4, 5=Emission class 5. For toll cost only, when co2EmissionClass is not specified then it defaults to 1. Providing invalid combination of emissionType and co2EmissionClass in request may result in incorrect toll costs.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","description":"Actual height of the overall rigid/semi truck including trailers: 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","description":"Actual height of the trailer(s). 350cm or 3.5m or 138in. For toll cost only, not considered for route path creation (use height parameter)
(Not available for Waypoints Sequence).","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","description":"Actual total weight of vehicle incl. payload, but not trailers' weight or payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","description":"Actual total weight of vehicle incl. payload and trailers/caravan incl. their payload. 7.5t or 7500kg or 16500lbs. For truck restrictions, speed profile, toll cost and environmental zone restrictions. See also vehicleWeight. Note that country wide weight restrictions depend on the number of axles and trailers as well, so it might be necessary to specify them as well.","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Legal maximum weight limit of vehicle incl. payload and trailers. Also incl. their payload as a total. 7.5t or 7500kg or 16500lbs. For truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","description":"1=vehicle equipped to carry disabled people, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","description":"Actual number of passengers. For toll cost. See also vehicle type carHOV.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","description":"Number of tires. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","description":"1=vehicle registered for commercial use, 0=otherwise. For toll cost, environmental zone regulations and delivery-only zones.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","description":"Comma separated list from explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable. For toll cost (only explosive and other) and for truck restrictions. For Waypoints Sequence, allhazardousGoods and explosiveFlammable are not supported.","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","description":"350cm or 3.5m or 138in. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","description":"Length of the vehicle (including potential trailers). 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxle","in":"query","description":"Actual total weight per axle, incl. payload. 7.5t or 7500kg or 16500lbs (Waypoints Sequence in kg, no unit). For toll cost and truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"width","in":"query","description":"Width of the vehicle, e.g. 350cm or 3.5m or 138in. For truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"tunnelCategory","in":"query","description":"Defines the tunnel categories the truck must NOT use. B, C, D or E. A tunnels have no restrictions. E tunnels have most restrictions. If C is defined, the route will use A and B tunnels but not C, D or E.","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","description":"Defines the fuel powering the vehicle. Can be Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric. (LPG=Liquefied Petroleum Gas, LNG=Liquefied Natural Gas). Used f.e. for environmental zone restrictions, toll cost calculation, consumption based routing for Electric vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"weightPerAxleGroup","in":"query","description":"Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported names are drive, single, tandem, triple, quad, quint. Example: &weightPerAxleGroup=drive:12;single:11;tandem:18
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailerWeight","in":"query","description":"Actual total weight of trailers with their payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.","required":false,"schema":{"type":"string"}},{"name":"overlays","in":"query","description":"Overlay map name. Case insensitive. Must start with OVERLAY and contain only characters.","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"fastest;car;traffic:disabled;[optional parameters] As optional parameters motorway (0, -1, -2, -3), tollroad (0, -1, -2, -3), boatFerry (0, -1, -2, -3), railFerry (0, -1, -2, -3), and tunnel (0, -1, -2, -3) can follow. \"shortest\" and \"balanced\" are not supported but can be individually tuned using &driver_cost and &vehicle_cost. Vehicle types: bdouble, bicycle, bus, car, carHOV, custom1, emergency, motorcycle, pedestrian, roadtrain, taxi, truck, motorhome","required":false,"schema":{"type":"string"}},{"name":"restTimes","in":"query","description":"Legal drive/rest intervals. Specify 'local' to obey the legal driver rest times of the respective country. Alternatively, proprietary values can be set for DriveTimeUntilShortBreak, ElapsedTimeUntilShortBreak, ShortBreakDuration, DriveTimeUntilLongRest, ElapsedTimeUntilLongBreak, LongRestDuration. E.g. EU requires after 4.5h a 45min break + after 9h an 11h rest. If the driver is not fresh then add ,TimeAlreadyDrivenSinceLastShortBreak, ElapsedTimeSinceLastShortBreak, TimeAlreadyDrivenSinceLastLongRest, ElapsedTimeSinceLastLongRest in seconds. Specify ;earlierRestTimeFactor:0.0 to take rest times much earlier to reduce travel time (arriving with less legal driving time left), default = 0.75","required":false,"schema":{"type":"string"}},{"name":"language","in":"query","description":"Language for the maneuver instructions in the response. Currently de-de, en-us, it-it, fr-fr, es-es, pt-pt, pl-pl, cs-cs, zh-cn, zh-tw, zh-hk and ja-jp are supported. If not specified, en-us is used.","required":false,"schema":{"type":"string"}},{"name":"avoidLinks","in":"query","description":"Comma separated list of link ids or lat,lon[;heading] coordinates to be avoided. Positive ids are not driven from reference node, negative ids are not driven towards reference node. Use '*' prefix to avoid both directions. For coordinates direction of blocking depends on the heading. If no heading given both directions will be avoided. Optionally an entry penalty (applied once while entering the sequence of link(s)) and drive penalty (applied to every link) can be specified individually for each link to be avoided, format: 'linkId[;penalty:entryPenaltySec[:drivePenaltyFactor]] or lat,lon[;penalty:entryPenaltySec[:drivePenaltyFactor]]'. entryPenalty should be between -120 and 600 (-ve penalty implies prefer), drivePenaltyFactor should be between 0.1 and 20.0 (1.0 implies no penalty, < 1.0 implies prefer). e.g. 1308094486;penalty:60:1.5,-1308094485;penalty:2:2.5 .","required":false,"schema":{"type":"string"}},{"name":"avoidAreas","in":"query","description":"List of areas (rectangles or polygons) to be avoided. Areas are separated by '!'. Rectangles can be specified with two diagonal coordinates separated by ';', e.g. latMax,lonMin;latMin,lonMax. Polygons are specified with consecutive vertex coordinates separated by ';', e.g. lat1,lon1;lat2,lon2;lat3,lon3;... . Optionally an entry penalty (applied once while entering the area) and drive penalty (applied to every link driven inside the area) can be specified individually for each area to be avoided, format: 'polygon1Coords[;penalty:entryPenaltySec[,drivePenaltyFactor]]!polygon2Coords[;penalty:entryPenaltySec[,drivePenaltyFactor]]'. entryPenalty should be between -120 and 600 (-ve penalty implies prefer), drivePenaltyFactor should be between 0.1 and 20.0 (1.0 implies no penalty, < 1.0 implies prefer). e.g. poly1lat1,poly1lon1,poly1lat2,poly1lon2,poly1lat3,poly1lon3;penalty:60,1.5!poly2lat1,poly2lon1,poly2lat2,poly2lon2,poly2lat3,poly2lon3;penalty:-100,0.5 .","required":false,"schema":{"type":"string"}},{"name":"arrival","in":"query","description":"Format like departure. Use this to find out when you have to start the journey to arrive at the given time. Note that toll cost is not considered when arrival time is specified.","required":false,"schema":{"type":"string"}},{"name":"rollups","in":"query","description":"Comma separated list of rollups (groupings, aggregation levels) in the result. Currently supported rollups are none (per link details), total (totals), tollsys (per toll system summaries), country (per country summaries), country;tollsys (per country and toll system summaries). Example: &rollups=none,country;tollsys,country returns the cost details and 2 different summaries.","required":false,"schema":{"type":"string"}},{"name":"speedFcCat","in":"query","description":"Comma separated list of speeds driven in kilometer per hour per road functional class (1-5 + Virtual Connections VC) and speed category (1-8) (f.e. FC1-SC1,FC1-SC2,...,FC1-SC8;FC2-SC1,FC2-SC2,...;...;VC-SC1,FC-SC2,...VC-SC8). Functional classes are semicolon separated. Can contain empty entries (no change to default f.e. 80,76,,,,,,;,,,54,46,,,;...). Overrides router's default driven speed values. Also one of the predefined profiles can be activated by value car, light-truck, medium-truck or heavy-truck","required":false,"schema":{"type":"string"}},{"name":"routeAttributes","in":"query","description":"Defines which information is included in the response route part of the calculated route. Defaults to mode (mo), waypoints (wp), summary (sm), flags (fl). Also supported: speedProfile (sp), shape (sh), summaryByCountry (sc), boundingBox (bb), none. Can be excluded in the response by putting a hyphen in the front. e.g. -wp","required":false,"schema":{"type":"string"}},{"name":"responseAttributes","in":"query","description":"Defines which information is included in the response as part of the calculated route. Defaults to warnings (wn). Also supported: language (lg), none. Can be excluded in the response by putting a hyphen in the front. e.g. -wn","required":false,"schema":{"type":"string"}},{"name":"metaAttributes","in":"query","description":"Defines which information is included in the meta part of the calculated route. Defaults to none. Also supported: version (ver), coverage (cov). Can be excluded in the response by putting a hyphen in the front. e.g. -ver","required":false,"schema":{"type":"string"}},{"name":"maneuverAttributes","in":"query","description":"Defines which information is included in the response as part of the data representation of the route maneuvers. Defaults to position (po), length (le), travelTime (tt). Also supported: direction (di), action (ac), indices (ix), lanes (ln), roadName(rn), nextRoadName (nr), beforeAfter (ba) and none.","required":false,"schema":{"type":"string"}},{"name":"legAttributes","in":"query","description":"Defines which information is included in the response as part of the route legs. Defaults to links (li), maneuvers (mn), length (le), travelTime (tt), baseTime (bt), trafficTime (tm). Also supported: shape (sh), boundingBox (bb), turnbyturnmaneuvers (mm), none. Can be excluded in the response by putting a hyphen in the front. e.g. -mn. Also in RouteMatch mode legAttributes=mn is supported.","required":false,"schema":{"type":"string"}},{"name":"linkAttributes","in":"query","description":"Define optional attributes to be returned for each link. Defaults to shape (sh), length (le), remainTime (rt), remainDistance (rd), functionalClass (fc), warnings (wn), confidence (cd). Also supported: cost (co), maneuver (ma), timezone (tz), none. Can be excluded in the response by putting a hyphen in the front. e.g. -ma","required":false,"schema":{"type":"string"}},{"name":"learnStopsId","in":"query","description":"Identifier of a profile to learn stop characteristics. Profiles can be defined arbitrarily, e.g by driver, vehicle, departure time or a combination of them. Parameter is used to learn while route matching. Cannot be used together with learnedStopsId.","required":false,"schema":{"type":"string"}},{"name":"learnedStopsId","in":"query","description":"Identifier of a profile to use stop characteristics. Profiles can be defined arbitrarily, e.g by driver, vehicle, departure time or a combination of them. Parameter is to apply learnings while routing. Cannot be used together with learnStopsId.","required":false,"schema":{"type":"string"}},{"name":"traverseGates","in":"query","description":"Assume the driver has keys/permissions to traverse gates, if \"true\". Accepted values are either \"true\" or \"airlineDistanceInMeters,entryPenaltyInSec\". Default = don't traverse any gates unless vehicle type is emergency.","required":false,"schema":{"type":"string"}},{"name":"routeMatch","in":"query","description":"Default: Compute a legal route that goes through all way points. 1 = treat the waypoints (or trace file POST body) as GPS trace and return the most probable route along this trace. 2 = ETA Tracking mode, compute the route and take the POST body GPS trace into account to detect taken driver rest times and reached/skipped waypoints. To get maneuvers for a matched route specify &legAttributes=mn.","required":false,"schema":{"type":"string"}},{"name":"legal","in":"query","description":"For routeMatch=1. Enforces a legal route w.r.t. the listed maneuver types. Support maneuver types (comma separated list): access,gate,oneway,thrutraf,turn. Passing all of them yields a legal route as from a router. access=use only links allowed for the vehicle type (incl. truck measures). gate=don't traverse gates. oneway=don't drive links into forbidden direction. thrutraf=don't enter+leaving 'no through traffic' zones. turn=don't turn/u-turn illegally. Default: avoid illegal maneuvers, but use them if the trace obviously used them. If used, return respective warnings.","required":false,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"Comma separated list of PDE layer names, to get link attributes along the route. Only link attribute layers (roughly those ending in _FC1, _FC2 ... ) are supported. Specify FCn to get the layers of all functional classes. Behind each layer name attributes can be listed, or (*) to get all. Example: &attributes=ROAD_GEOM_FCn(TUNNEL), SPEED_LIMITS_FCn (FROM_REF_SPEED_LIMIT, TO_REF_SPEED_LIMIT), ADAS_ATTRIB_FCn (SLOPES). A maximum of 32 layers can be requested per request.","required":false,"schema":{"type":"string"}},{"name":"tollPass","in":"query","description":"Comma separated list of owned passes: Senior_Pass, transponder (the car has all transponders), noTransponder (have no transponder and use no system that requires one), allPasses, Annual, Nr_of_Days, Nr_of_Months (meaning the car has all passes valid for this number of months), AutoPass, SunPass, E-Z Pass (last 2 are examples for real toll transponders). Can also list toll system ids or toll booth condition ids. Allows traversal of 'transponder-only' toll booths, allows cost free traversal of certain toll sections and allows using cheaper prices for transponder/pass owners.","required":false,"schema":{"type":"string"}},{"name":"capacity","in":"query","description":"Comma separated list of numeric truck capacity limits. E.g. 8,25,6 for max. 8t payload and max. 25 square meter floor space and max 6 passengers. Must match the 'load' values of way points. For unsorted or optional way points.","required":false,"schema":{"type":"string"}},{"name":"customConsumptionDetails","in":"query","description":"Semicolon separated list of speed/ascent/descent/builtupFactor/auxilliaryConsumption fuel consumption parameters. Speed is a list of $/km for different speeds. Ascent/descent are additional $/km per altitude climbed or descended. Builtup factor is an optional heuristic consumption multiplier for urban area, default value is 1.55. auxilliaryConsumption is the additional consumption (per hour) for running auxilliary units (climate control, infotainment, lights, etc.). Cost unit is not $ but 'currency'. Example: speed,0,0.102,10,0.084,30,0.066,50,0.06,70,0.066,100,0.072,120,0.084,140,0.108; ascent,0.4; descent,0.1; builtupFactor,1.4 = at 70 kph the car consumes 6.6$/100km and 0.4$/km altitude climbed, consumption increases 40% in urban area. Alternatively, user can specify default consumption profile: 3.5t, 7.5t, 18t, 40t or weightDependent. In case of the weightDependent consumption profiles will be decided based on the limitedWeight so this parameter also needs to be specified.","required":false,"schema":{"type":"string"}},{"name":"alternatives","in":"query","description":"Maximum number of alternative route options to return. Can return less or no alternatives. Only returns route alternatives that significantly differ from the best route but are not much more costly.","required":false,"schema":{"type":"string"}},{"name":"timeout","in":"query","description":"Routing calculation must be finished within this amount of milliseconds. Default 50000. Maximum 50000.","required":false,"schema":{"type":"string"}},{"name":"ignoreWaypointVehicleRestriction","in":"query","description":"Format: radius[;drivePenaltyFactor[;type[;entryPenalty]]]. radius: in meters around a waypoint to ignore various vehicle restrictions (vehicle type, admin truck, time-based, construction closed) if necessary. drivePenaltyFactor: (cost multiplier 0...1) to control how strict to avoid restrictions. type: restrictions types (time based restrictions/all permanent restriction/construction status) to be ignored, accepted values are: all,allTimed,construction. entryPenalty: penalty in seconds (0....7200) applied once while ignoring each restriction type (like entering a 'no through traffic' or entering a 'admin truck restricted' area), default - 3600 (1 hour). Example1: ignoreWaypointVehicleRestriction=2000. Example2: ignoreWaypointVehicleRestriction=2000;;allTimed . Example3: ignoreWaypointVehicleRestriction=5000;0.9;construction,all;1800 .","required":false,"schema":{"type":"string"}},{"name":"maxSpeed","in":"query","description":"Maximum speed allowed for the whole routing. Supported units are kmh (kilometres per hour), mph (miles per hour) and mps (metres per second). If no unit is provided, kmh will be used as default unit.","required":false,"schema":{"type":"string"}},{"name":"alignToGpsTime","in":"query","description":"Route matching tries to align the driving time to the GPS timestamps. On per default. Set to 0 to switch it off.","required":false,"schema":{"type":"string"}},{"name":"customAttributes","in":"query","description":"Comma separated list of CLE layer names, to get link attributes along the route. Format follows the 'attribute' parameter. No FCn notation supported","required":false,"schema":{"type":"string"}},{"name":"mapMatchRadius","in":"query","description":"Maximum adaptive map match search radius [meter]. Will be applied to each way point. If given it overrides waypoints' transitRadius values and the default maximum adaptive search radius. For routing, default 1600. Limit 5000.","required":false,"schema":{"type":"string"}},{"name":"excludeCountries","in":"query","required":false,"schema":{"type":"string"}},{"name":"excludeZoneTypes","in":"query","description":"Checks if a route may enter a zone. Currently supported values: environmental,vignette and congestionPricing. If omitted or empty, zone restrictions are not taken into account. Not supported for route matching.","required":false,"schema":{"type":"string"}},{"name":"requestId","in":"query","description":"Mirrored RequestId value from the request structure. Used to trace requests.","required":false,"schema":{"type":"string"}},{"name":"instructionFormat","in":"query","description":"Defines the representation format of the maneuver's instruction text. Supported formats are text|html","required":false,"schema":{"type":"string"}},{"name":"oneway","in":"query","description":"Default: Obey oneways. 'penalty:0.5' allows oneway violation if the time benefit is more than 0.5 sec/meter. For bicycle recommended value 0.125, for emergencies 0.5. Not allowed for other vehicles.","required":false,"schema":{"type":"string"}},{"name":"drivingReport","in":"query","description":"Defines whether driving report is added to the route match response. Set to 1 to switch it on. Turned off by default.","required":false,"schema":{"type":"string"}},{"name":"ignorePreferredRoutes","in":"query","description":"Preferred routes for a specific vehicle type, are taken by default. To turn if off set ignorePreferredRoutes to true.","required":false,"schema":{"type":"string"}},{"name":"avoidTurns","in":"query","description":"Comma separated list of elements like left[;minAngleDegree;penaltySec] or right... or uTurn[;penaltySec] if a left/right turn is sharper than the specified angle (0...180) then the given time penalty is applied. uTurnAtWaypoint avoids u-turning on the link directly where the waypoint was reached.","required":false,"schema":{"type":"string"}},{"name":"ignoreZeroSpeedPoints","in":"query","description":"Only for route matching. Default = consider all points. 1 = ignore trace points that have zero speed (only in traces that provide speed but not time).","required":false,"schema":{"type":"string"}},{"name":"wpDist","in":"query","description":"Only for route matching. 0 = default value, feature is disabled. 1 = return spatial distance between matched trace points. 2 = return spatial distance between original trace points","required":false,"schema":{"type":"string"}},{"name":"chargingStationFilters","in":"query","description":"URL Encoded comma separated list of charging stations to filter out the electric vehicle charging stations, along the route.","required":false,"schema":{"type":"string"}},{"name":"makeReachable","in":"query","description":"A route will be returned even there are not sufficient fuel/EV-charging stations along the route consumption/energy details if this parameter is set to true. Default = false.","required":false,"schema":{"type":"string"}},{"name":"cellularSignals","in":"query","required":false,"schema":{"type":"string"}},{"name":"plannedWaypointReachTolerance","in":"query","description":"Only for routeMatch=2 with learned stops. Default = 20000 meter. If the trace gets closer then the learned stop is considered reached","required":false,"schema":{"type":"string"}},{"name":"customRestrLimit","in":"query","description":"Comma separated list of key value pairs of custom restriction limits. The key and value of individual custom restriction limit must be numeric and must be separated by colon. Example: 0:10,1:20,2:50","required":false,"schema":{"type":"string"}},{"name":"evPoiLayer","in":"query","description":"Name of the layer which will be used to find the Electric Charging Stations along the route for Electric Vehicle Routing","required":false,"schema":{"type":"string"}},{"name":"routeMatch2PlannedWayPointReachRadius","in":"query","description":"Only for routeMatch=2. If vehicle approaches a planned waypoint closer than this then the waypoint is considered reached. Default 20000.0m.","required":false,"schema":{"type":"string"}},{"name":"detectSkippedPlannedWaypoint","in":"query","description":"Only for routeMatch=2. Default to true. This flag enables/disables the logic to analyze the GPS trace and determines which planned waypoints are skipped. You can prevent waypoint skipping by setting this value to false.","required":false,"schema":{"type":"string"}},{"name":"ignoreWaypointsFarFromNeighbors","in":"query","description":"Only for routeMatch> 0. Default true. If false then doesn't ignore a trace point when it is much further away from its neighbors than the usual distances in the trace","required":false,"schema":{"type":"string"}},{"name":"wayPointHeadingMismatchPenaltyFactor","in":"query","description":"Tie waypoints closer to links where the GPS heading matches the link's heading, and try harder to meet waypoints in the given driving direction. Default = 1.","required":false,"schema":{"type":"string"}},{"name":"avoidPrivate","in":"query","description":"Use private streets for routing. Set to 1 to always allow it or -1 to always forbid it. Default is 0 - access is allowed if there is a waypoint in the private street.","required":false,"schema":{"type":"string"}},{"name":"licensePlate","in":"query","description":"Licenseplate of the vehicle. The vehicles registration number can influence the permission to drive in certain zones, mostly environmental zones. For enhanced privacy, irrelevant license plate letters/digits can be dummy values.","required":false,"schema":{"type":"string"}},{"name":"adminTruckRestrictions","in":"query","description":"Per default admin wide truck restrictions are obeyed. 'ignore' ignores them.","required":false,"schema":{"type":"string"}},{"name":"mapMatchTolerance","in":"query","description":"Map match tolerance [meter]. Will be applied to each way point. Routing can meet the waypoint on all links that are that much further away from the coordinate than the nearest. Default 3.0.","required":false,"schema":{"type":"string"}},{"name":"privateChargingStation","in":"query","description":"If true then private charging stations will be considered during routing. Default is false.","required":false,"schema":{"type":"string"}},{"name":"costPerConsumptionUnit","in":"query","description":"The cost of a consumption unit in targetCurrency. Default is 1.","required":false,"schema":{"type":"string"}},{"name":"restTimeDriverCost","in":"query","description":"Cost per hour in target currency while driver is taking a legal rest time. Can be between 0 and driver_cost value.","required":false,"schema":{"type":"string"}},{"name":"avoidFeatures","in":"query","description":"Comma separated list of road features to be avoided. Currently supported: unpaved[;300;50]. Avoids unpaved roads by the specified seconds to enter (Entry penalty) and seconds/km driven (drive penalty), or a default penalty","required":false,"schema":{"type":"string"}},{"name":"truckVerified","in":"query","description":"Make use of truck verified roads for truck routing. 1 prefers transport verified roads, 0 uses verified and non verified without preference.","required":false,"schema":{"type":"string"}},{"name":"metricSystem","in":"query","description":"Set to 'imperial' to receive guidance instruction distances in miles. Default = metric.","required":false,"schema":{"type":"string"}},{"name":"avoidCountryChange","in":"query","description":"Penalties in seconds to avoid unnecessary waiting time on border crossings. Countries should be specified according to 3 character ISO 3166 standard. A comma should be used to separate the multiple avoidChangeCountry on the route. Format: Country code1-Country code2:Penalty in seconds[,Country code1-Country code2:Penalty in seconds]","required":false,"schema":{"type":"string"}},{"name":"trafficIncidents","in":"query","description":"Set 'true'/'false' to enable/disable usage of traffic incidents (road blocks) during route estimation for the complete length of route, default is 'false' - traffic incidents are disabled. Usage of traffic incidents will impact the routing response time, use only if necessary.","required":false,"schema":{"type":"string"}},{"name":"pathCoordinates","in":"query","description":"Set 1 to get a minimum sequence of coordinates back that you can send to any router to enforce exactly this route. Default 0. Only for route matching, enabled by routeMatch=1. Returns a coordinate after each junction (if a minimum distance traveled since previous). This distance is by default 50m and can be changed by sub-parameter minDist:","required":false,"schema":{"type":"string"}},{"name":"followPath","in":"query","description":"Pass a sequence of link IDs defining the route path. Syntax: F: or L:LinkID0;LinkID1;...","required":false,"schema":{"type":"string"}},{"name":"waypoint0 ... waypointN","in":"query","description":"Comma separated waypoint latitude, longitude in WGS-84 degree. The coordinates may be directly followed by ;transitRadius;label;heading[;optional specifications]. \r\nA route must consist of at least 2 waypoints (start and destination). The coordinates may be directly followed by ;transitRadius;label;heading. \r\nThe maximum number of waypoints is limited. However, this limit is not a fixed number but is a result of the limit for the overall processing time. \r\nSet a transit radius to only influence the route to go via a certain city (Example: &waypoint1=50.12,8.65;10000). \r\nSet a heading (degree clockwise from North) to improve map matching (Example: latitude,longitude;;;140). \r\nTo define a loading time or delay time at a waypoint, use stopOver[,timeInSeconds]! (Example: &waypoint1=stopOver,300!50.12,8.65). \r\nThe optional specifications altitude, custom label, !StreetPosition and !LinkPosition, ignoreRestriction are currently supported.\r\nTo define a radius around the waypoint where vehicle restrictions should be ignored use optional specification ';ignoreRestriction:radius[,drivePenalty[,type[,entryPenalty]]]. Example: &waypoint1=50.12,8.65;ignoreRestriction:8000,0.9,all,1800 . \r\nThis is similar to the global parameter 'ignoreWaypointVehicleRestriction' which applies to all waypoint. But when specified explicitly for a waypoint, the 'ignoreRestriction' specification of waypoint is applied. \r\nWaypoints can have opening and closing times, can be unsorted or optional. Details are in Key Concepts / Waypoint sorting, optional Pickup and Opening Times","required":true,"schema":{"type":"string"}},{"name":"file","in":"query","description":"Trace file for route matching. GPX, NMEA, KML, CSV or AGORA-C.","required":true,"style":"form","schema":{"type":"string","format":"binary"}},{"name":"jsonCallback","in":"query","description":"Specifies the function used to wrap the JSON response","schema":{"type":"string"}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/Response"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}},"/1/search/corridor.json":{"get":{"tags":["Map Attributes","Search"],"summary":"Retrieve layer content within given geo corridor","description":"Retrieve the layer content records within an airline distance along a given polyline. Does not work for custom layers.","operationId":"searchCorridor_2","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"layer_ids","in":"query","description":"Comma separated list of layer names to be searched. Layer names are not case sensitive. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json","required":true,"schema":{"type":"string"}},{"name":"key_attributes","in":"query","description":"the key column(s) of this layer, as defined in the layer specification","required":true,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"List of comma separated column names to specify which attributes shall appear in the result. Column names are not case sensitive. Default = all.","required":false,"schema":{"type":"string"}},{"name":"corridor","in":"query","description":"Either corridor, route_id or routeHandle is required.\r\nThe WGS84 degree coordinates of the polyline used as corridor center line.\r\nFor example:\r\nlatitude 1,longitude 1;latitude 2,longitude 2;...","required":false,"schema":{"type":"string"}},{"name":"route_id","in":"query","description":"Either corridor, route_id or routeHandle is required.\r\nA route_id obtained from a previous v7.2 Router call. This route_id will be turned into a corridor polyline.","required":false,"schema":{"type":"string"}},{"name":"routeHandle","in":"query","description":"Either corridor, route_id or routeHandle is required.\r\nA routeHandle obtained from a previous v8 Router call. This routeHandle will be turned into a corridor polyline.","required":false,"schema":{"type":"string"}},{"name":"radius","in":"query","description":"The buffer search radius in meters.All geometries overlapping the corridor polygon will be returned.","required":true,"schema":{"type":"number","format":"double"}},{"name":"geom","in":"query","description":"local, full or none. Specifies the geometry representation in the result. Default = local. Local geometry is used for map display purposes, returning geometry pieces that cover the given search radius, bounding box or corridor polygon. Full geometry is used for interactive editing, where the original geometry is required. None is used for applications like geofencing, which most of the time want to know only the ids of the geofence points/lines polygons they are in or near.","required":false,"schema":{"type":"string","default":"local"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"The routing mode (e.g. fastest;car;traffic:disabled) that determines how the route is calculated. When route_id/routeHandle is used for the corridor search then please specify the same mode which was used to get the route id or route handle.","required":false,"schema":{"type":"string"}},{"name":"transportMode","in":"query","description":"Mode of transport to be used for the route calculation: car, truck, pedestrian;It determines how the route is calculated. When routeHandle is used for the corridor search then please specify the same transportMode which was used to get the route handle.","required":false,"schema":{"type":"string"}},{"name":"routingMode","in":"query","description":"Specifies which optimization is applied during route calculation: fast, short;It determines how the route is calculated. When routeHandle is used for the corridor search then please specify the same routingMode which was used to get the route handle.","required":false,"schema":{"type":"string"}},{"name":"region","in":"query","description":"Optional (default=whole world excl. JPN, CHN, SK). Map coverage region, e.g. APAC, AUS, WEU, IND, MEA, NA, SAM, TWN, JPN. The region may contain hints to distinguish specific content. E.g. there can be an WEU and PCBEU, where the 2nd map contains only Postal Code Boundary layers. If not specified, the service will find the region(s) automatically, that cover the request. The parameter can contain a comma separated list of regions (f.e. WEU,MEA). If the region parameter is specified, the service will use these region(s) and skip region(s) that may also cover the response (f.e. EEU). Except of JPN, specifying a region is strongly discouraged, because regions might change and hence applications that specify a region might stop working when the region gets discontinued, renamed, split or changed otherwise. As the APAC region contains a simplified entry map content of JPN, JPN needs to be specified as region to access the full JPN content.","required":false,"schema":{"type":"string"}},{"name":"release","in":"query","description":"Map release quarter, e.g. 2015Q4, 161J0, 16153 or LATEST (= default) for the latest available map release quarter. Specifying a map release is strongly discouraged, because there is no guarantee how long old map releases are available, hence applications that specify a release might stop working when the release gets retired. To choose a specific snapshot of the live traffic speed record or archived weather layer, a UNIX timestamp (number of milliseconds since 1970) or a date in 2017-12-01T17:30:00+01:00 format can be passed.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/GeometrySearchResponse"}}}}}},"post":{"tags":["Map Attributes","Search"],"summary":"Retrieve layer content within given geo corridor","description":"Retrieve the layer content records within an airline distance along a given polyline. Does not work for custom layers.","operationId":"searchCorridor_3","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"layer_ids","in":"query","description":"Comma separated list of layer names to be searched. Layer names are not case sensitive. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json","required":true,"schema":{"type":"string"}},{"name":"key_attributes","in":"query","description":"the key column(s) of this layer, as defined in the layer specification","required":true,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"List of comma separated column names to specify which attributes shall appear in the result. Column names are not case sensitive. Default = all.","required":false,"schema":{"type":"string"}},{"name":"corridor","in":"query","description":"Either corridor, route_id or routeHandle is required.\r\nThe WGS84 degree coordinates of the polyline used as corridor center line.\r\nFor example:\r\nlatitude 1,longitude 1;latitude 2,longitude 2;...","required":false,"schema":{"type":"string"}},{"name":"route_id","in":"query","description":"Either corridor, route_id or routeHandle is required.\r\nA route_id obtained from a previous v7.2 Router call. This route_id will be turned into a corridor polyline.","required":false,"schema":{"type":"string"}},{"name":"routeHandle","in":"query","description":"Either corridor, route_id or routeHandle is required.\r\nA routeHandle obtained from a previous v8 Router call. This routeHandle will be turned into a corridor polyline.","required":false,"schema":{"type":"string"}},{"name":"radius","in":"query","description":"The buffer search radius in meters.All geometries overlapping the corridor polygon will be returned.","required":true,"schema":{"type":"number","format":"double"}},{"name":"geom","in":"query","description":"local, full or none. Specifies the geometry representation in the result. Default = local. Local geometry is used for map display purposes, returning geometry pieces that cover the given search radius, bounding box or corridor polygon. Full geometry is used for interactive editing, where the original geometry is required. None is used for applications like geofencing, which most of the time want to know only the ids of the geofence points/lines polygons they are in or near.","required":false,"schema":{"type":"string","default":"local"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"The routing mode (e.g. fastest;car;traffic:disabled) that determines how the route is calculated. When route_id/routeHandle is used for the corridor search then please specify the same mode which was used to get the route id or route handle.","required":false,"schema":{"type":"string"}},{"name":"transportMode","in":"query","description":"Mode of transport to be used for the route calculation: car, truck, pedestrian;It determines how the route is calculated. When routeHandle is used for the corridor search then please specify the same transportMode which was used to get the route handle.","required":false,"schema":{"type":"string"}},{"name":"routingMode","in":"query","description":"Specifies which optimization is applied during route calculation: fast, short;It determines how the route is calculated. When routeHandle is used for the corridor search then please specify the same routingMode which was used to get the route handle.","required":false,"schema":{"type":"string"}},{"name":"region","in":"query","description":"Optional (default=whole world excl. JPN, CHN, SK). Map coverage region, e.g. APAC, AUS, WEU, IND, MEA, NA, SAM, TWN, JPN. The region may contain hints to distinguish specific content. E.g. there can be an WEU and PCBEU, where the 2nd map contains only Postal Code Boundary layers. If not specified, the service will find the region(s) automatically, that cover the request. The parameter can contain a comma separated list of regions (f.e. WEU,MEA). If the region parameter is specified, the service will use these region(s) and skip region(s) that may also cover the response (f.e. EEU). Except of JPN, specifying a region is strongly discouraged, because regions might change and hence applications that specify a region might stop working when the region gets discontinued, renamed, split or changed otherwise. As the APAC region contains a simplified entry map content of JPN, JPN needs to be specified as region to access the full JPN content.","required":false,"schema":{"type":"string"}},{"name":"release","in":"query","description":"Map release quarter, e.g. 2015Q4, 161J0, 16153 or LATEST (= default) for the latest available map release quarter. Specifying a map release is strongly discouraged, because there is no guarantee how long old map releases are available, hence applications that specify a release might stop working when the release gets retired. To choose a specific snapshot of the live traffic speed record or archived weather layer, a UNIX timestamp (number of milliseconds since 1970) or a date in 2017-12-01T17:30:00+01:00 format can be passed.","required":false,"schema":{"type":"string"}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/GeometrySearchResponse"}}}}}}},"/version":{"get":{"tags":["monitoring-controller"],"operationId":"getVersionTXT","responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}}}}}},"head":{"tags":["monitoring-controller"],"operationId":"getVersionTXT_1","responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"string"}}}}}}},"/version.json":{"get":{"tags":["monitoring-controller"],"operationId":"getVersionJSON","parameters":[{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}},"head":{"tags":["monitoring-controller"],"operationId":"getVersionJSON_1","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/version.html":{"get":{"tags":["monitoring-controller"],"operationId":"getVersionHTML","parameters":[{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}],"responses":{"200":{"description":"OK","content":{"text/html":{"schema":{"type":"string"}}}}}},"head":{"tags":["monitoring-controller"],"operationId":"getVersionHTML_1","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"text/html":{"schema":{"type":"string"}}}}}}},"/stats":{"get":{"tags":["monitoring-controller"],"operationId":"getStats","parameters":[{"name":"algopts","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"trafficForkDest","in":"query","required":false,"schema":{"type":"string"}},{"name":"trafficForkDurationSec","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"trafficForkAppIds","in":"query","required":false,"schema":{"type":"string"}},{"name":"trafficForkAppIdsInclude","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"trafficForkMaxRPS","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"trafficForkMaxConnections","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"trafficForkMapToApiKey","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain;charset=UTF-8":{"schema":{"type":"string"}}}}}},"head":{"tags":["monitoring-controller"],"operationId":"getStats_1","parameters":[{"name":"algopts","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"trafficForkDest","in":"query","required":false,"schema":{"type":"string"}},{"name":"trafficForkDurationSec","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"trafficForkAppIds","in":"query","required":false,"schema":{"type":"string"}},{"name":"trafficForkAppIdsInclude","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"trafficForkMaxRPS","in":"query","required":false,"schema":{"type":"number","format":"double"}},{"name":"trafficForkMaxConnections","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"trafficForkMapToApiKey","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/plain;charset=UTF-8":{"schema":{"type":"string"}}}}}}},"/startup":{"get":{"tags":["monitoring-controller"],"operationId":"getStartup","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}},"head":{"tags":["monitoring-controller"],"operationId":"getStartup_1","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/serviceconfiguration.txt":{"get":{"tags":["monitoring-controller"],"operationId":"getServiceConfiguration","parameters":[{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}],"responses":{"200":{"description":"OK","content":{"text/plain;charset=UTF-8":{"schema":{"type":"string"}}}}}},"head":{"tags":["monitoring-controller"],"operationId":"getServiceConfiguration_1","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"text/plain;charset=UTF-8":{"schema":{"type":"string"}}}}}}},"/serviceconfiguration.json":{"get":{"tags":["monitoring-controller"],"operationId":"getServiceConfiguration_2","parameters":[{"name":"callback","in":"query","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}},"head":{"tags":["monitoring-controller"],"operationId":"getServiceConfiguration_3","parameters":[{"name":"callback","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/serviceconfiguration":{"get":{"tags":["monitoring-controller"],"operationId":"getServiceConfiguration_4","parameters":[{"name":"callback","in":"query","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}},"head":{"tags":["monitoring-controller"],"operationId":"getServiceConfiguration_5","parameters":[{"name":"callback","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/monitor.json":{"get":{"tags":["monitoring-controller"],"operationId":"getMonitor","parameters":[{"name":"key","in":"query","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}},"head":{"tags":["monitoring-controller"],"operationId":"getMonitor_1","parameters":[{"name":"key","in":"query","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/live":{"get":{"tags":["monitoring-controller"],"operationId":"getLiveness","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}},"head":{"tags":["monitoring-controller"],"operationId":"getLiveness_1","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/healthcheck":{"get":{"tags":["monitoring-controller"],"operationId":"getHealthCheck","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}},"head":{"tags":["monitoring-controller"],"operationId":"getHealthCheck_1","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/v8/matches":{"post":{"tags":["Route Matching V8"],"summary":"Match GPS traces to get the most probably driven path.","operationId":"matchRoute","parameters":[{"name":"transportMode","in":"query","description":"Specify vehicle type, if known.","required":false,"style":"form","schema":{"type":"string","enum":["bdouble","bicycle","bus","car","emergency","motorcycle","pedestrian","roadtrain","taxi","truck"]}},{"name":"legal","in":"query","description":"Enforces a legal route w.r.t. the listed maneuver types. Support maneuver types (comma separated list): \n- access, use links only allowed for the vehicle type (incl. truck measures). \n- gate, don't traverse gates. \n- oneway, don't drive links into forbidden direction. \n- throughTraffic, don't enter/leave 'no through traffic' zones. \n- turn, don't turn/u-turn illegally. \nPassing all of them yields a legal path. Default: avoid illegal maneuvers, but use them if the trace obviously used them. If used, return respective warning notes.","required":false,"style":"form","schema":{"type":"array","items":{"type":"string","enum":["access","gate","oneway","throughTraffic","turn"]}}},{"name":"return","in":"query","description":"Defines which attributes are included in the route match response. For example, using 'drivingReport' will return several additional risk relevant attributes.","required":false,"style":"form","schema":{"type":"string","enum":["drivingReport"]}},{"name":"zeroSpeedPoints","in":"query","description":"Specifies whether to ignore trace points that have zero speed (only when timestamp is not provided in the trace).","required":false,"style":"form","schema":{"type":"string","enum":["considerAll","ignoreAll"],"default":"considerAll"}},{"name":"tracePointsFarFromNeighbors","in":"query","description":"Specifies whether to ignore trace points that are much further away from their neighbors than the usual distances in the trace.","required":false,"style":"form","schema":{"type":"string","enum":["considerAll","ignoreAll"],"default":"ignoreAll"}},{"name":"vehicle","in":"query","description":"Vehicle parameters to be used during route matching.","required":false,"style":"deepObject","schema":{"$ref":"#/components/schemas/VehicleSpec"}},{"name":"X-Request-ID","in":"header","description":"User provided request identifier for tracking","schema":{"type":"string"}}],"requestBody":{"description":"POST body 'tracefile' in GPX, NMEA, KML, CSV, AGORA-C or GeoJson format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TraceGeoJson"},"example":{"type":"FeatureCollection","features":[{"type":"Feature","properties":{"timestamp":1666845363,"speed_mps":17.5},"geometry":{"type":"Point","coordinates":[50.10778,8.61622]}}]}},"application/octet-stream":{"schema":{"type":"string","format":"binary"},"example":"trace file in GPX, NMEA, KML, CSV or AGORA-C format"}},"required":true},"responses":{"429":{"description":"Rate limit exceeded.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id","style":"simple"},"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id","style":"simple"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseError"}}}},"400":{"description":"Request contains invalid parameters.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id","style":"simple"},"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id","style":"simple"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseError"}}}},"403":{"description":"Access denied.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id","style":"simple"},"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id","style":"simple"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthError"}}}},"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id","style":"simple"},"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id","style":"simple"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RouteMatchResponse"}}}},"401":{"description":"Authentication failed.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id","style":"simple"},"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id","style":"simple"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthError"}}}},"500":{"description":"Unexpected service error.","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id","style":"simple"},"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id","style":"simple"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseError"}}}}}}},"/v8/maps/upload":{"post":{"tags":["Map Attributes V8"],"summary":"Import Geometries in a WKT or Shape File - deprecated","description":"Import polygons, polylines or points in WKT (Wellknown Text) or Shapefile format geometries using an HTTP POST request. A layer can contain only one geometry type - polygons, polylines or points, but not a mix of different types. After the response there is a delay of several seconds to compile, store and make the geometries available in the service.","operationId":"v8UploadPost","parameters":[{"name":"layerId","in":"query","description":"Unique identifier for the layer in the format {app_id}.{mapName}.{layerName}. app_id: app_id of the project creating the layer; mapName: the map into which the layer is uploaded, default = upload the layer into the app_id's default map; layerName: Name of layer to create/replace, the maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json.","required":true,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Specify tile size for the database for performance optimization, if not specified default tile size of 12 is used.","required":false,"schema":{"type":"integer","format":"int32","default":12}},{"name":"storage","in":"query","description":"Either updatable or readonly. Default = updatable.","required":false,"schema":{"type":"string","default":"updatable"}},{"name":"wktQuote","in":"query","description":"Specify the quote character to use. Default = \" (double quotes). Specifying NONE disables quotes.","required":false,"schema":{"type":"string","default":"\""}},{"name":"indexColumns","in":"query","description":"Specify columns of the layer that should be indexed. Column name is followed by semi-colon(;) and indexing type. Supported indexing type are: order(o), text(t) or both order,text(o,t). Columns are separated by pipe(|). Example &indexColumns=POI_ID;order|CAT_ID;text|ADMIN_IDS;order,text","required":false,"schema":{"type":"string"}},{"name":"grantedAppIds","in":"query","description":"Comma separated list of app_ids which also have (per default read+export) access to this layer (specifying ownerAppId.mapName.layerName). Example &granted_app_ids=otherAppId1,otherAppId2","required":false,"schema":{"type":"string"}},{"name":"file","in":"query","description":"WKT file content","required":true,"style":"form","schema":{"type":"string","format":"binary"}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayerUploadResponse"}}}}}}},"/v8/maps/modify":{"post":{"tags":["Map Attributes V8"],"summary":"Modify Geometries in Existing Layers - deprecated","description":"Modify geometries using an HTTP POST request. After the response there is a delay of several seconds to compile, store and make the modified geometries available in the service.\r\nNote: The level (tile grid size) of the layer can only be changed by uploading the whole layer, not as a modification operation.","operationId":"v8ModifyPost","parameters":[{"name":"layerId","in":"query","description":"Unique identifier for the layer in the format {app_id}.{mapName}.{layerName}. app_id: app_id of the project modifying the layer; mapName: the map into which the layer is uploaded, default = upload the layer into the app_id's default map; layerName: Name of layer to modify, the maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json.","required":true,"schema":{"type":"string"}},{"name":"action","in":"query","description":"append, update or delete. Geometries are identified by their geometry_id column value. For append, the geometries must not exist yet and will be added. For update, the geometries must exist and will be replaced. All column values must be specified, not only the changes. For update and delete, the columns must not change - names, sequence orders and type must be identical. For delete, the geometries must exist and will be replaced. Only the geometry_id column is required.","required":true,"schema":{"type":"string"}},{"name":"wktQuote","in":"query","description":"Specify the quote character to use. Default = \" (double quotes). Specifying NONE disables quotes.","required":false,"schema":{"type":"string","default":"\""}},{"name":"owner_app_id","in":"query","description":"Owner app_id that was used to upload the custom layer.","required":false,"schema":{"type":"string"}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"409":{"description":"Modify Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayerModifyResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayerModifyResponse"}}}}}}},"/v8/geofence":{"get":{"tags":["Geofencing V8"],"summary":"Simple and fast search for geometries on HERE Map Content layers, extensible with custom geometry layers","description":"Simple and fast search for geometries on HERE Map Content layers, extensible with custom geometry layers","operationId":"geofence","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"layers","in":"query","description":"Comma separated list of layers to be searched. Layer names are not case sensitive. Both custom layers and Map Attribute layers are supported. Map Attribute layers divided by functional class, like ROAD_GEOM_FC1 ... FC5 can be selected by N, e.g. ROAD_GEOM_FCN. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json. Via the attributes parameter only certain column attributes from a layer can be returned.","required":false,"schema":{"type":"string"}},{"name":"in","in":"query","description":"Spatial filtering for multi layer search, supported is 'assetPositions'. The filtering is specified as json structure for each asset 'point'. It should be URL encoded when specified as part of GET request, else in json format for POST request. Each asset 'point' should have properties 'lat', 'lon', 'layer' and 'searchRadius'. The property 'attributes' is optional to control the returned attributes of map objects. Omitting it will result in attribution of the returned objects.\r\n Example: assetPositions:{\"point\": [{ \"lat\" : 41.9101, \"lon\" : 12.5021, \"layer\" : \"ROAD_GEOM_FC3\", \"searchRadius\" : 100 },{ \"lat\" : 42.0299, \"lon\" : 12.6932, \"layer\" : \"ROAD_GEOM_FC5\", \"searchRadius\" : 200, \"attributes\" : [\"LINK_ID\", \"NAME\", \"TUNNEL\", \"BRIDGE\" ] }]}","required":false,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"A SQL expression being evaluated for each geometry being returned from the specified layer listing.\r\nColumns value for the geometry are available as defined variables.\r\nWhen specified, only geometries where expression evaluates to true will be returned.\r\nSupport SQL filter operators are: '=', '!=', '>', '<', 'AND', 'OR', 'LIKE'.\r\nExample: filter=RATING > 3 AND NAME != 'MyPlace23' AND NAME LIKE 'FOOD%' \r\nParameter value must be url encoded when using special characters.\r\nThis filter expression is applied to all geometries, so it can become slow for big layers.\r\nTo avoid service overload, filter expressions must not exceed 100 characters of text. Filter expression is applied to all objects from all layers specified. For that reason it will most likely work as expected if a single layer is requested.","required":false,"schema":{"type":"string","default":""}},{"name":"meta","in":"query","description":"When set to 1 then meta info is returned in the response. The default value is 1.","required":false,"schema":{"type":"string","default":"1"}},{"name":"attributes","in":"query","description":"Semicolon separated list of column names (in uppercase) to specify which attributes shall appear in the result. If the request specifies several layers, then pass this for each layer as a comma separated list. Default = all. F.e. if layers=LINK_ATTRIBUTE2_FCn,LINK_ATTRIBUTE_FCn,ROAD_GEOM_FCn are requested, then the columns can be restricted to only following attributes=PARKING_LOT_ROAD;CARPOOL_ROAD,PAVED;PRIVATE,BRIDGE;TUNNEL. Parking lot and carpool road are from layer LINK_ATTRIBUTE2_FCn, paved and private from LINK_ATTRIBUTE_FCn and bridge, tunnel from ROAD_GEOM_FCn layer.","required":false,"schema":{"type":"string"}},{"name":"map_name","in":"query","description":"Optional. Map within to look for the layer. Default: Look into the default map.","required":false,"schema":{"type":"string"}},{"name":"owner_app_id","in":"query","description":"Owner app_id that was used to upload a layer. It is mandatory when a granted app_id is used to access the layer.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/MapAttributesV8Response"}}}}}},"post":{"tags":["Geofencing V8"],"summary":"Simple and fast search for geometries on HERE Map Content layers, extensible with custom geometry layers","description":"Simple and fast search for geometries on HERE Map Content layers, extensible with custom geometry layers","operationId":"geofencePost","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"layers","in":"query","description":"Comma separated list of layer names to be searched. Layer names are not case sensitive. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json. Via the attributes parameter only certain column attributes from a layer can be returned.","required":false,"schema":{"type":"string"}},{"name":"in","in":"query","description":"Spatial filtering for multi layer search, supported is 'assetPositions'. The filtering is specified as json structure for each asset 'point'. It should be URL encoded when specified as part of GET request, else in json format for POST request. Each asset 'point' should have properties 'lat', 'lon', 'layer' and 'searchRadius'. The property 'attributes' is optional to control the returned attributes of map objects. Omitting it will result in attribution of the returned objects.\r\n Example: assetPositions:{\"point\": [{ \"lat\" : 41.9101, \"lon\" : 12.5021, \"layer\" : \"ROAD_GEOM_FC3\", \"searchRadius\" : 100 },{ \"lat\" : 42.0299, \"lon\" : 12.6932, \"layer\" : \"ROAD_GEOM_FC5\", \"searchRadius\" : 200, \"attributes\" : [\"LINK_ID\", \"NAME\", \"TUNNEL\", \"BRIDGE\" ] }]}","required":false,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"A SQL expression being evaluated for each geometry being returned from the specified layer listing.\r\nColumns value for the geometry are available as defined variables.\r\nWhen specified, only geometries where expression evaluates to true will be returned.\r\nSupport SQL filter operators are: '=', '!=', '>', '<', 'AND', 'OR', 'LIKE'.\r\nExample: filter=RATING > 3 AND NAME != 'MyPlace23' AND NAME LIKE 'FOOD%' \r\nParameter value must be url encoded when using special characters.\r\nThis filter expression is applied to all geometries, so it can become slow for big layers.\r\nTo avoid service overload, filter expressions must not exceed 100 characters of text. Filter expression is applied to all objects from all layers specified. For that reason it will most likely work as expected if a single layer is requested.","required":false,"schema":{"type":"string","default":""}},{"name":"meta","in":"query","description":"When set to 1 then meta info is returned in the response. The default value is 1.","required":false,"schema":{"type":"string","default":"1"}},{"name":"attributes","in":"query","description":"Semicolon separated list of column names (in uppercase) to specify which attributes shall appear in the result. If the request specifies several layers, then pass this for each layer as a comma separated list. Default = all. F.e. if layers=LINK_ATTRIBUTE2_FCn,LINK_ATTRIBUTE_FCn,ROAD_GEOM_FCn are requested, then the columns can be restricted to only following attributes=PARKING_LOT_ROAD;CARPOOL_ROAD,PAVED;PRIVATE,BRIDGE;TUNNEL. Parking lot and carpool road are from layer LINK_ATTRIBUTE2_FCn, paved and private from LINK_ATTRIBUTE_FCn and bridge, tunnel from ROAD_GEOM_FCn layer.","required":false,"schema":{"type":"string"}},{"name":"map_name","in":"query","description":"Optional. Map within to look for the layer. Default: Look into the default map.","required":false,"schema":{"type":"string"}},{"name":"owner_app_id","in":"query","description":"Owner app_id that was used to upload a layer. It is mandatory when a granted app_id is used to access the layer.","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json;charset=UTF-8":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},"text/plain;charset=UTF-8":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"415":{"description":"Bad mediatype. Supported values: application/json, text/plain","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/MapAttributesV8Response"}}}},"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/MapAttributesV8Response"}}}}}}},"/v8/geofence/upload":{"post":{"tags":["Geofencing V8"],"summary":"Import Geometries in a WKT or Shape File","description":"Import polygons, polylines or points in WKT (Wellknown Text) or Shapefile format geometries using an HTTP POST request. A layer can contain only one geometry type - polygons, polylines or points, but not a mix of different types. After the response there is a delay of several seconds to compile, store and make the geometries available in the service.","operationId":"v8UploadPost_1","parameters":[{"name":"layerId","in":"query","description":"Unique identifier for the layer in the format {app_id}.{mapName}.{layerName}. app_id: app_id of the project creating the layer; mapName: the map into which the layer is uploaded, default = upload the layer into the app_id's default map; layerName: Name of layer to create/replace, the maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json.","required":true,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Specify tile size for the database for performance optimization, if not specified default tile size of 12 is used.","required":false,"schema":{"type":"integer","format":"int32","default":12}},{"name":"storage","in":"query","description":"Either updatable or readonly. Default = updatable.","required":false,"schema":{"type":"string","default":"updatable"}},{"name":"wktQuote","in":"query","description":"Specify the quote character to use. Default = \" (double quotes). Specifying NONE disables quotes.","required":false,"schema":{"type":"string","default":"\""}},{"name":"indexColumns","in":"query","description":"Specify columns of the layer that should be indexed. Column name is followed by semi-colon(;) and indexing type. Supported indexing type are: order(o), text(t) or both order,text(o,t). Columns are separated by pipe(|). Example &indexColumns=POI_ID;order|CAT_ID;text|ADMIN_IDS;order,text","required":false,"schema":{"type":"string"}},{"name":"grantedAppIds","in":"query","description":"Comma separated list of app_ids which also have (per default read+export) access to this layer (specifying ownerAppId.mapName.layerName). Example &granted_app_ids=otherAppId1,otherAppId2","required":false,"schema":{"type":"string"}},{"name":"file","in":"query","description":"WKT file content","required":true,"style":"form","schema":{"type":"string","format":"binary"}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayerUploadResponse"}}}}}}},"/v8/geofence/modify":{"post":{"tags":["Geofencing V8"],"summary":"Modify Geometries in Existing Layers","description":"Modify geometries using an HTTP POST request. After the response there is a delay of several seconds to compile, store and make the modified geometries available in the service.\r\nNote: The level (tile grid size) of the layer can only be changed by uploading the whole layer, not as a modification operation.","operationId":"v8ModifyPost_1","parameters":[{"name":"layerId","in":"query","description":"Unique identifier for the layer in the format {app_id}.{mapName}.{layerName}. app_id: app_id of the project modifying the layer; mapName: the map into which the layer is uploaded, default = upload the layer into the app_id's default map; layerName: Name of layer to modify, the maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json.","required":true,"schema":{"type":"string"}},{"name":"action","in":"query","description":"append, update or delete. Geometries are identified by their geometry_id column value. For append, the geometries must not exist yet and will be added. For update, the geometries must exist and will be replaced. All column values must be specified, not only the changes. For update and delete, the columns must not change - names, sequence orders and type must be identical. For delete, the geometries must exist and will be replaced. Only the geometry_id column is required.","required":true,"schema":{"type":"string"}},{"name":"wktQuote","in":"query","description":"Specify the quote character to use. Default = \" (double quotes). Specifying NONE disables quotes.","required":false,"schema":{"type":"string","default":"\""}},{"name":"owner_app_id","in":"query","description":"Owner app_id that was used to upload the custom layer.","required":false,"schema":{"type":"string"}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"409":{"description":"Modify Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayerModifyResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayerModifyResponse"}}}}}}},"/2/layers/upload.json":{"get":{"tags":["Upload Data"],"summary":"Import Geometries in a WKT or Shape File","description":"Import polygons, polylines or points in WKT (Wellknown Text) or Shapefile format geometries using an HTTP POST request, or import WKT geometries using HTTP GET. A layer can contain only one geometry type - polygons, polylines or points, but not a mix of different types. After the response there is a delay of several seconds to compile, store and make the geometries available in the service.","operationId":"uploadGet","parameters":[{"name":"file","in":"query","description":"For GET requests: URL-encoded WKT file content as parameter value. For POST requests: Instead of this parameter, a multipart/form-data body is sent. The filename of the multipart entity is arbitrary. The file can be a plain or zipped WKT text file ending with .wkt, or a zipped archive containing a .shp, .shx and .dbf file (optionally .prj or .cpg files). A WKT file consists of TAB separated elements. The first line contains the column names, the last column must be \"wkt\". The subsequent lines contain the content, the attributes and the geometry. To create an index on a set of columns for faster all.json responses, append ;* to these column names.","required":true,"schema":{"type":"string"}},{"name":"layer_id","in":"query","description":"Name of layer to create/replace. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json.","required":true,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Specify tile size for the database for performance optimization","required":false,"schema":{"type":"integer","format":"int32","default":12}},{"name":"storage","in":"query","description":"Either updatable or readonly. Default = updatable.","required":false,"schema":{"type":"string","default":"updatable"}},{"name":"wkt_quote","in":"query","description":"Specify the quote character to use. Default = \" (double quotes). Specifying NONE disables quotes.","required":false,"schema":{"type":"string","default":"\""}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"map_name","in":"query","description":"upload the layer into this map, default = upload the layer into the app_id's default map","required":false,"schema":{"type":"string"}},{"name":"indexColumns","in":"query","description":"Specify columns of the layer that should be indexed. Column name is followed by semi-colon(;) and indexing type. Supported indexing type are: order(o), text(t) or both order,text(o,t). Columns are separated by pipe(|). Example &indexColumns=POI_ID;order|CAT_ID;text|ADMIN_IDS;order,text","required":false,"schema":{"type":"string"}},{"name":"granted_app_ids","in":"query","description":"Comma separated list of app_ids which also have (per default read+export) access to this layer (specifying ownerAppId.mapName.layerName). Example &granted_app_ids=otherAppId1,otherAppId2","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayerUploadResponse"}}}}}},"post":{"tags":["Upload Data"],"summary":"Import Geometries in a WKT or Shape File","description":"Import polygons, polylines or points in WKT (Wellknown Text) or Shapefile format geometries using an HTTP POST request, or import WKT geometries using HTTP GET. A layer can contain only one geometry type - polygons, polylines or points, but not a mix of different types. After the response there is a delay of several seconds to compile, store and make the geometries available in the service.","operationId":"uploadPost","parameters":[{"name":"layer_id","in":"query","description":"Name of layer to create/replace. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json.","required":true,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Specify tile size for the database for performance optimization","required":false,"schema":{"type":"integer","format":"int32","default":12}},{"name":"storage","in":"query","description":"Either updatable or readonly. Default = updatable.","required":false,"schema":{"type":"string","default":"updatable"}},{"name":"wkt_quote","in":"query","description":"Specify the quote character to use. Default = \" (double quotes). Specifying NONE disables quotes.","required":false,"schema":{"type":"string","default":"\""}},{"name":"map_name","in":"query","description":"upload the layer into this map, default = upload the layer into the app_id's default map","required":false,"schema":{"type":"string"}},{"name":"indexColumns","in":"query","description":"Specify columns of the layer that should be indexed. Column name is followed by semi-colon(;) and indexing type. Supported indexing type are: order(o), text(t) or both order,text(o,t). Columns are separated by pipe(|). Example &indexColumns=POI_ID;order|CAT_ID;text|ADMIN_IDS;order,text","required":false,"schema":{"type":"string"}},{"name":"granted_app_ids","in":"query","description":"Comma separated list of app_ids which also have (per default read+export) access to this layer (specifying ownerAppId.mapName.layerName). Example &granted_app_ids=otherAppId1,otherAppId2","required":false,"schema":{"type":"string"}},{"name":"file","in":"query","description":"WKT file content","required":true,"style":"form","schema":{"type":"string","format":"binary"}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string","description":"WKT file content","format":"binary"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayerUploadResponse"}}}}}}},"/2/layers/modify.json":{"get":{"tags":["Upload Data"],"summary":"Modify Geometries in Existing Layers","description":"Modify geometries using an HTTP GET or POST request. After the response there is a delay of several seconds to compile, store and make the modified geometries available in the service.\r\nNote: The level (tile grid size) of the layer can only be changed by uploading the whole layer, not as a modification operation.","operationId":"modifyGet","parameters":[{"name":"changes","in":"query","description":"For GET requests: URL-encoded WKT file content as parameter value. For POST requests: Instead of this parameter, a multipart/form-data body is sent. The supported file formats and the parameter name are the same as for upload.json, but content for modify.json must be always URL encoded, even if POSTed.","required":true,"schema":{"type":"string"}},{"name":"layer_id","in":"query","description":"name of layer to modify","required":true,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"action","in":"query","description":"append, update or delete. Geometries are identified by their geometry_id column value. For append, the geometries must not exist yet and will be added. For update, the geometries must exist and will be replaced. All column values must be specified, not only the changes. For update and delete, the columns must not change - names, sequence orders and type must be identical. For delete, the geometries must exist and will be replaced. Only the geometry_id column is required.","required":true,"schema":{"type":"string"}},{"name":"wkt_quote","in":"query","description":"Specify the quote character to use. Default = \" (double quotes). Specifying NONE disables quotes.","required":false,"schema":{"type":"string","default":"\""}},{"name":"map_name","in":"query","description":"update the layer in this map, default = update the layer within the app_id's default map","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"owner_app_id","in":"query","description":"Owner app_id that was used to upload a layer.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"409":{"description":"Modify Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayerModifyResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayerModifyResponse"}}}}}},"post":{"tags":["Upload Data"],"summary":"Modify Geometries in Existing Layers","description":"Modify geometries using an HTTP GET or POST request. After the response there is a delay of several seconds to compile, store and make the modified geometries available in the service.\r\nNote: The level (tile grid size) of the layer can only be changed by uploading the whole layer, not as a modification operation. Uploaded content for modification must be URL encoded (even for POST).","operationId":"modifyPost","parameters":[{"name":"layer_id","in":"query","description":"name of layer to modify","required":true,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"action","in":"query","description":"append, update or delete. Geometries are identified by their geometry_id column value. For append, the geometries must not exist yet and will be added. For update, the geometries must exist and will be replaced. All column values must be specified, not only the changes. For update and delete, the columns must not change - names, sequence orders and type must be identical. For delete, the geometries must exist and will be replaced. Only the geometry_id column is required.","required":true,"schema":{"type":"string"}},{"name":"map_name","in":"query","description":"update the layer in this map, default = update the layer within the app_id's default map","required":false,"schema":{"type":"string"}},{"name":"wkt_quote","in":"query","description":"Specify the quote character to use. Default = \" (double quotes). Specifying NONE disables quotes.","required":false,"schema":{"type":"string","default":"\""}},{"name":"owner_app_id","in":"query","description":"Owner app_id that was used to upload a layer.","required":false,"schema":{"type":"string"}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"409":{"description":"Modify Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayerModifyResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayerModifyResponse"}}}}}}},"/2/findsequence.json":{"get":{"tags":["Waypoints Sequence"],"description":"Compute best Sequence for Waypoints (Travelling Salesman Problem).","operationId":"findSequenceGET","parameters":[{"name":"start","in":"query","description":"Waypoint to start the sequence.
Example:
&start=Munich;48.132777,11.565352","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"Waypoint to be reached at the end of the sequence. Usage is optional, but recommended.
Example:
&end=Paris;48.857397,2.346642","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"The routing mode determines how the route is calculated.
Type;TransportModes;TrafficMode;RouteFeature1,RouteFeature2
Calculation is limited to transport modes car, truck, bicycle, scooter, taxi, bus and pedestrian. Transport types are shortest and fastest. TrafficMode can be enabled or disabled. RouteFeatures can be used to avoid certain types of roads to a certain degree. Road features are: tollroad, motorway, boatFerry, railFerry, tunnel, dirtRoad, park. Usage of any such links can be restricted with values 0 (normal) to -4 (strict avoid). Delimiter between RouteFeatuers are commas.
Examples:
&mode=fastest;car;traffic:disabled;motorway:-2
&mode=fastest;car;traffic:enabled;motorway:-2,tollroad:-2","required":true,"schema":{"type":"string"}},{"name":"departure","in":"query","description":"Time when travel is expected to start. Traffic speed and incidents are taken into account when calculating the route. You can use now to specify the current time. Type: xs:dateTime.
Example:
&departure=2021-07-04T17:00:00+02:00","required":false,"schema":{"type":"string"}},{"name":"hasTrailer","in":"query","description":"Does the vehicle tow a trailer? Values: true/false","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","description":"0=None, 1=Caravan, 2=Trailer, 3=RVTrailer, 4=BoatTrailer. For toll cost and recreational vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","description":"Number of trailers, 0...4. For toll cost and truck restrictions. 0=no trailer, 1=one or more trailers, 2=two or more trailers, 3=three or more trailers. For truck restrictions: 4=one or more semi-trailers.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","description":"Number of axles excluding trailers. For toll cost and for country wide truck restrictions.
","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","description":"Number of trailer axles. For toll cost and for country wide truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","description":"1=fuel+electric, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","description":"1=EURO I, 2=EURO II, 3=EURO III, 4=EURO IV, 5=EURO V, 6=EURO VI, 7=EURO EEV, 8=Electric Vehicles, 9=EURO II with PRC, 10=EURO III with PRC. For toll cost and environmental zone restrictions, when emissionType is not specified it defaults to 5.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","description":"CO2 emission class of the vehicle. 1=Emission class 1, 2=Emission class 2, 3=Emission class 3, 4=Emission class 4, 5=Emission class 5. For toll cost only, when co2EmissionClass is not specified then it defaults to 1. Providing invalid combination of emissionType and co2EmissionClass in request may result in incorrect toll costs.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","description":"Actual height of the overall rigid/semi truck including trailers: 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","description":"Actual height of the trailer(s). 350cm or 3.5m or 138in. For toll cost only, not considered for route path creation (use height parameter)
(Not available for Waypoints Sequence).","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","description":"Actual total weight of vehicle incl. payload, but not trailers' weight or payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","description":"Actual total weight of vehicle incl. payload and trailers/caravan incl. their payload. 7.5t or 7500kg or 16500lbs. For truck restrictions, speed profile, toll cost and environmental zone restrictions. See also vehicleWeight. Note that country wide weight restrictions depend on the number of axles and trailers as well, so it might be necessary to specify them as well.","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Legal maximum weight limit of vehicle incl. payload and trailers. Also incl. their payload as a total. 7.5t or 7500kg or 16500lbs. For truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","description":"1=vehicle equipped to carry disabled people, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","description":"Actual number of passengers. For toll cost. See also vehicle type carHOV.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","description":"Number of tires. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","description":"1=vehicle registered for commercial use, 0=otherwise. For toll cost, environmental zone regulations and delivery-only zones.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","description":"Comma separated list from explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable. For toll cost (only explosive and other) and for truck restrictions. For Waypoints Sequence, allhazardousGoods and explosiveFlammable are not supported.","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","description":"350cm or 3.5m or 138in. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","description":"Length of the vehicle (including potential trailers). 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxle","in":"query","description":"Actual total weight per axle, incl. payload. 7.5t or 7500kg or 16500lbs (Waypoints Sequence in kg, no unit). For toll cost and truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"width","in":"query","description":"Width of the vehicle, e.g. 350cm or 3.5m or 138in. For truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"tunnelCategory","in":"query","description":"Defines the tunnel categories the truck must NOT use. B, C, D or E. A tunnels have no restrictions. E tunnels have most restrictions. If C is defined, the route will use A and B tunnels but not C, D or E.","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","description":"Defines the fuel powering the vehicle. Can be Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric. (LPG=Liquefied Petroleum Gas, LNG=Liquefied Natural Gas). Used f.e. for environmental zone restrictions, toll cost calculation, consumption based routing for Electric vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"weightPerAxleGroup","in":"query","description":"Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported names are drive, single, tandem, triple, quad, quint. Example: &weightPerAxleGroup=drive:12;single:11;tandem:18
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailerWeight","in":"query","description":"Actual total weight of trailers with their payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.","required":false,"schema":{"type":"string"}},{"name":"avoidSegments","in":"query","description":"Links which the route must not cross. The list of LinkIdTypes. LinkIdType is a xs:string with the following regular expression restrictions: [*-+]\\d+
Example:
&avoidLinks=-53623477","required":false,"schema":{"type":"string"}},{"name":"avoidAreas","in":"query","description":"Areas which the route must not cross. Array of up to 20 BoundingBox-es.
Example with two bounding boxes:
avoidAreas=52.517100760,13.3905424488;52.5169701849,13.391808451!52.517000760,13.3700424488;52.5168701849,13.371308451","required":false,"schema":{"type":"string"}},{"name":"excludeCountries","in":"query","description":"A list of three-letter country codes (ISO-3166-1 alpha-3 code) to be excluded from the underlying route calculations. Excluding countries near or between waypoints may result in incalculable routes.","required":false,"schema":{"type":"string"}},{"name":"avoidUTurns","in":"query","description":"This option avoids U-turns on highways and motorways. It is not supported for pedestrian, bicycle and scooter transport modes. Values: true/false. Default: false","required":false,"schema":{"type":"string"}},{"name":"improveFor","in":"query","description":"Measure to optimize. Values: distance,time. Default: time","required":false,"schema":{"type":"string"}},{"name":"jsonCallback","in":"query","description":"Specifies the function used to wrap the JSON response","required":false,"schema":{"type":"string"}},{"name":"requestId","in":"query","description":"Request Id returned in the response to match it with the request","required":false,"schema":{"type":"string","default":""}},{"name":"restTimes","in":"query","description":"Activates the accounting for rest times. Rest times are modelled with a short and a long cycle. Both cycles consist of a driving phase and a resting phase..
Also it can be specified if times at waypoint (service times) should be counted as
restTimes=durations:{short driving time in seconds},{short rest time in seconds},{long driving time in seconds},{long rest time in seconds;serviceTimes:work|rest.
Also the value can be set as default 'restTimes=default' which activates simplified European rules with 45min rest after 4.5h hours driving and 11h of long rest after 9h working, service times are accounted as work.
Example:
&restTimes=durations:16200,2700,32400,39600;serviceTimes:work","required":false,"schema":{"type":"string"}},{"name":"truckType","in":"query","description":"Truck routing only, specifies the vehicle type. Values:truck | tractorTruck, Defaults to truck. ","required":false,"schema":{"type":"string"}},{"name":"walkSpeed","in":"query","description":"Sets the speed (m/s), if the routing mode comes with 'pedestrian'","required":false,"schema":{"type":"string"}},{"name":"evChargingTimePerDistance","in":"query","description":"Activates accounting of times for charging electric vehicles. Requires a distance to be driven in Meter and the time in seconds required to recharge the energy required for the given distance.
Example:
evChargingTimePerDistance=7200,250000","required":false,"schema":{"type":"string"}},{"name":"clustering","in":"query","description":"The \"clustering\" parameter enables clustering of the waypoints. Two clustering algorithms are supported; drivingDistance and topologySegment.
The algorithm drivingDistance is a connectivity-based clustering algorithm where all waypoints of a cluster are within a driving distance of 50 meters of the specified vehicle in both directions. A custom value of the driving distance can be specified by drivingDistance:distanceInMeter.
The algorithm topologySegment creates a cluster of waypoints that can be map-matched to the same topology segment.
Examples:
&clustering=drivingDistance:100
&clustering=topologySegment","required":false,"schema":{"type":"string"}},{"name":"driverCost","in":"query","description":"Cost per hour in arbitrary currency.","required":false,"schema":{"type":"string"}},{"name":"vehicleCost","in":"query","description":"Cost per kilometer in arbitrary currency.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}},{"name":"destination0...destinationN or waypoint0...waypointN","in":"query","description":"There are two ways of specifying locations to be visited. Below is the documentation of destination0...destinationN.
Using the notation of waypoint0 ... waypointN switches the behavior of this endpoint to the find pickups scenario. This includes the availability, limitations and the syntax of the parameters.
For calculating other sequences using \"destination...\" is recommended.
Usage of destination0...destinationN:
A waypoint of this service contains an id, a set of latitude, longitude in WGS-84 degree and constraints, which may impose certain restrictions when calculating the sequence.
The format is [ID;]latitude,longitude[;st:{time in seconds}][[;acc:opening hours]|[;at:appointment]][;before:destinationNumber of other waypoint][;sideOfStreetHint:[matchSideOfStreet,]displayLatitude,displayLongitude].
The constraints are:
st: service time spent at the waypoint is seconds. Example: st:300
at: an appointment, requires the service time as the duration of the appointment. Example: at:2021-11-15T16:00:00+02:00;st:1800
acc: access hours when a destination can be visited. Requires a service time setting. Example: acc:mo12:00:00+02:00|fr18:00:00+02:00;st:900
before: referencing a destination which must be reached later. Example: before:7
acc and at cannot be used together on the same destination.
sideOfStreetHint: specifies the preferred side of street for the waypoint. It is typically the display location of an address or POI (point of interest) on the side of the road, available from Geocoder Search response. It consists of an optional parameter matchSideOfStreet and coordinates.
matchSideOfStreet determines how the hint would be handled. Possible values are:
'always' meaning the hint should always be used.
'onlyIfDivided' which means the hint should only be used on roads where traffic in opposite directions is divided; either there's a physical separation between lanes, or it's legally not allowed to cross them.
Default value for matchSideOfStreet is 'onlyIfDivided'
When retrieving the coordinates via the HERE Geocoding API, the navigational coordinates from the field \"access\" should be used for the latitude and longitude of a destination.
Examples:
&destination3=Berlin_appointment;52.51605,13.37691;at:2021-10-14T16:00:00+02:00;st:300
&destination11=Bratislava_limited_access;48.154722,17.145556;acc:tu06:00:00+02:00|tu20:00:00+02:00;st:900
&destination12=Copenhagen_long_servicetime;st:7200
&destination17=Malmo_before_Copenhagen55.600289,12.995798;before:12
&destination20=Frankfurt_market50.113029,8.683684;sideOfStreetHint:always,50.112970,8.683692","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/WseResponse"}}}}}},"post":{"tags":["Waypoints Sequence"],"description":"Compute best Sequence for Waypoints (Travelling Salesman Problem).","operationId":"findSequencePOST","parameters":[{"name":"start","in":"query","description":"Waypoint to start the sequence.
Example:
&start=Munich;48.132777,11.565352","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"Waypoint to be reached at the end of the sequence. Usage is optional, but recommended.
Example:
&end=Paris;48.857397,2.346642","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"The routing mode determines how the route is calculated.
Type;TransportModes;TrafficMode;RouteFeature1,RouteFeature2
Calculation is limited to transport modes car, truck, bicycle, scooter, taxi, bus and pedestrian. Transport types are shortest and fastest. TrafficMode can be enabled or disabled. RouteFeatures can be used to avoid certain types of roads to a certain degree. Road features are: tollroad, motorway, boatFerry, railFerry, tunnel, dirtRoad, park. Usage of any such links can be restricted with values 0 (normal) to -4 (strict avoid). Delimiter between RouteFeatuers are commas.
Examples:
&mode=fastest;car;traffic:disabled;motorway:-2
&mode=fastest;car;traffic:enabled;motorway:-2,tollroad:-2","required":true,"schema":{"type":"string"}},{"name":"departure","in":"query","description":"Time when travel is expected to start. Traffic speed and incidents are taken into account when calculating the route. You can use now to specify the current time. Type: xs:dateTime.
Example:
&departure=2021-07-04T17:00:00+02:00","required":false,"schema":{"type":"string"}},{"name":"hasTrailer","in":"query","description":"Does the vehicle tow a trailer? Values: true/false","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","description":"0=None, 1=Caravan, 2=Trailer, 3=RVTrailer, 4=BoatTrailer. For toll cost and recreational vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","description":"Number of trailers, 0...4. For toll cost and truck restrictions. 0=no trailer, 1=one or more trailers, 2=two or more trailers, 3=three or more trailers. For truck restrictions: 4=one or more semi-trailers.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","description":"Number of axles excluding trailers. For toll cost and for country wide truck restrictions.
","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","description":"Number of trailer axles. For toll cost and for country wide truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","description":"1=fuel+electric, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","description":"1=EURO I, 2=EURO II, 3=EURO III, 4=EURO IV, 5=EURO V, 6=EURO VI, 7=EURO EEV, 8=Electric Vehicles, 9=EURO II with PRC, 10=EURO III with PRC. For toll cost and environmental zone restrictions, when emissionType is not specified it defaults to 5.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","description":"CO2 emission class of the vehicle. 1=Emission class 1, 2=Emission class 2, 3=Emission class 3, 4=Emission class 4, 5=Emission class 5. For toll cost only, when co2EmissionClass is not specified then it defaults to 1. Providing invalid combination of emissionType and co2EmissionClass in request may result in incorrect toll costs.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","description":"Actual height of the overall rigid/semi truck including trailers: 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","description":"Actual height of the trailer(s). 350cm or 3.5m or 138in. For toll cost only, not considered for route path creation (use height parameter)
(Not available for Waypoints Sequence).","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","description":"Actual total weight of vehicle incl. payload, but not trailers' weight or payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","description":"Actual total weight of vehicle incl. payload and trailers/caravan incl. their payload. 7.5t or 7500kg or 16500lbs. For truck restrictions, speed profile, toll cost and environmental zone restrictions. See also vehicleWeight. Note that country wide weight restrictions depend on the number of axles and trailers as well, so it might be necessary to specify them as well.","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Legal maximum weight limit of vehicle incl. payload and trailers. Also incl. their payload as a total. 7.5t or 7500kg or 16500lbs. For truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","description":"1=vehicle equipped to carry disabled people, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","description":"Actual number of passengers. For toll cost. See also vehicle type carHOV.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","description":"Number of tires. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","description":"1=vehicle registered for commercial use, 0=otherwise. For toll cost, environmental zone regulations and delivery-only zones.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","description":"Comma separated list from explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable. For toll cost (only explosive and other) and for truck restrictions. For Waypoints Sequence, allhazardousGoods and explosiveFlammable are not supported.","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","description":"350cm or 3.5m or 138in. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","description":"Length of the vehicle (including potential trailers). 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxle","in":"query","description":"Actual total weight per axle, incl. payload. 7.5t or 7500kg or 16500lbs (Waypoints Sequence in kg, no unit). For toll cost and truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"width","in":"query","description":"Width of the vehicle, e.g. 350cm or 3.5m or 138in. For truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"tunnelCategory","in":"query","description":"Defines the tunnel categories the truck must NOT use. B, C, D or E. A tunnels have no restrictions. E tunnels have most restrictions. If C is defined, the route will use A and B tunnels but not C, D or E.","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","description":"Defines the fuel powering the vehicle. Can be Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric. (LPG=Liquefied Petroleum Gas, LNG=Liquefied Natural Gas). Used f.e. for environmental zone restrictions, toll cost calculation, consumption based routing for Electric vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"weightPerAxleGroup","in":"query","description":"Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported names are drive, single, tandem, triple, quad, quint. Example: &weightPerAxleGroup=drive:12;single:11;tandem:18
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailerWeight","in":"query","description":"Actual total weight of trailers with their payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.","required":false,"schema":{"type":"string"}},{"name":"avoidLinks","in":"query","description":"Links which the route must not cross. The list of LinkIdTypes. LinkIdType is a xs:string with the following regular expression restrictions: [*-+]\\d+
Example:
&avoidLinks=-53623477","required":false,"schema":{"type":"string"}},{"name":"avoidSegments","in":"query","description":"Links which the route must not cross. The list of LinkIdTypes. LinkIdType is a xs:string with the following regular expression restrictions: [*-+]\\d+
Example:
&avoidLinks=-53623477","required":false,"schema":{"type":"string"}},{"name":"avoidAreas","in":"query","description":"Areas which the route must not cross. Array of up to 20 BoundingBox-es.
Example with two bounding boxes:
avoidAreas=52.517100760,13.3905424488;52.5169701849,13.391808451!52.517000760,13.3700424488;52.5168701849,13.371308451","required":false,"schema":{"type":"string"}},{"name":"excludeCountries","in":"query","description":"A list of three-letter country codes (ISO-3166-1 alpha-3 code) to be excluded from the underlying route calculations. Excluding countries near or between waypoints may result in incalculable routes.","required":false,"schema":{"type":"string"}},{"name":"avoidUTurns","in":"query","description":"This option avoids U-turns on highways and motorways. It is not supported for pedestrian, bicycle and scooter transport modes. Values: true/false. Default: false","required":false,"schema":{"type":"string"}},{"name":"improveFor","in":"query","description":"Measure to optimize. Values: distance,time. Default: time","required":false,"schema":{"type":"string"}},{"name":"jsonCallback","in":"query","description":"Specifies the function used to wrap the JSON response","required":false,"schema":{"type":"string"}},{"name":"requestId","in":"query","description":"Request Id returned in the response to match it with the request","required":false,"schema":{"type":"string","default":""}},{"name":"restTimes","in":"query","description":"Activates the accounting for rest times. Rest times are modelled with a short and a long cycle. Both cycles consist of a driving phase and a resting phase..
Also it can be specified if times at waypoint (service times) should be counted as
restTimes=durations:{short driving time in seconds},{short rest time in seconds},{long driving time in seconds},{long rest time in seconds;serviceTimes:work|rest.
Also the value can be set as default 'restTimes=default' which activates simplified European rules with 45min rest after 4.5h hours driving and 11h of long rest after 9h working, service times are accounted as work.
Example:
&restTimes=durations:16200,2700,32400,39600;serviceTimes:work","required":false,"schema":{"type":"string"}},{"name":"truckType","in":"query","description":"Truck routing only, specifies the vehicle type. Values:truck | tractorTruck, Defaults to truck. ","required":false,"schema":{"type":"string"}},{"name":"walkSpeed","in":"query","description":"Truck routing only, specifies the vehicle type. Values:truck | tractorTruck, Defaults to truck. ","required":false,"schema":{"type":"string"}},{"name":"evChargingTimePerDistance","in":"query","description":"Activates accounting of times for charging electric vehicles. Requires a distance to be driven in Meter and the time in seconds required to recharge the energy required for the given distance.
Example:
evChargingTimePerDistance=7200,250000","required":false,"schema":{"type":"string"}},{"name":"clustering","in":"query","description":"The \"clustering\" parameter enables clustering of the waypoints. Two clustering algorithms are supported; drivingDistance and topologySegment.
The algorithm drivingDistance is a connectivity-based clustering algorithm where all waypoints of a cluster are within a driving distance of 50 meters of the specified vehicle in both directions. A custom value of the driving distance can be specified by drivingDistance:distanceInMeter.
The algorithm topologySegment creates a cluster of waypoints that can be map-matched to the same topology segment.
Examples:
&clustering=drivingDistance:100
&clustering=topologySegment","required":false,"schema":{"type":"string"}},{"name":"driverCost","in":"query","description":"Cost per hour in arbitrary currency.","required":false,"schema":{"type":"string"}},{"name":"vehicleCost","in":"query","description":"Cost per kilometer in arbitrary currency.","required":false,"schema":{"type":"string"}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}},{"name":"destination0...destinationN or waypoint0...waypointN","in":"query","description":"There are two ways of specifying locations to be visited. Below is the documentation of destination0...destinationN.
Using the notation of waypoint0 ... waypointN switches the behavior of this endpoint to the find pickups scenario. This includes the availability, limitations and the syntax of the parameters.
For calculating other sequences using \"destination...\" is recommended.
Usage of destination0...destinationN:
A waypoint of this service contains an id, a set of latitude, longitude in WGS-84 degree and constraints, which may impose certain restrictions when calculating the sequence.
The format is [ID;]latitude,longitude[;st:{time in seconds}][[;acc:opening hours]|[;at:appointment]][;before:destinationNumber of other waypoint][;sideOfStreetHint:[matchSideOfStreet,]displayLatitude,displayLongitude].
The constraints are:
st: service time spent at the waypoint is seconds. Example: st:300
at: an appointment, requires the service time as the duration of the appointment. Example: at:2021-11-15T16:00:00+02:00;st:1800
acc: access hours when a destination can be visited. Requires a service time setting. Example: acc:mo12:00:00+02:00|fr18:00:00+02:00;st:900
before: referencing a destination which must be reached later. Example: before:7
acc and at cannot be used together on the same destination.
sideOfStreetHint: specifies the preferred side of street for the waypoint. It is typically the display location of an address or POI (point of interest) on the side of the road, available from Geocoder Search response. It consists of an optional parameter matchSideOfStreet and coordinates.
matchSideOfStreet determines how the hint would be handled. Possible values are:
'always' meaning the hint should always be used.
'onlyIfDivided' which means the hint should only be used on roads where traffic in opposite directions is divided; either there's a physical separation between lanes, or it's legally not allowed to cross them.
Default value for matchSideOfStreet is 'onlyIfDivided'
When retrieving the coordinates via the HERE Geocoding API, the navigational coordinates from the field \"access\" should be used for the latitude and longitude of a destination.
Examples:
&destination3=Berlin_appointment;52.51605,13.37691;at:2021-10-14T16:00:00+02:00;st:300
&destination11=Bratislava_limited_access;48.154722,17.145556;acc:tu06:00:00+02:00|tu20:00:00+02:00;st:900
&destination12=Copenhagen_long_servicetime;st:7200
&destination17=Malmo_before_Copenhagen55.600289,12.995798;before:12
&destination20=Frankfurt_market50.113029,8.683684;sideOfStreetHint:always,50.112970,8.683692","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},"*/*":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/WseResponse"}}}}}}},"/v8/findsequence2":{"get":{"tags":["Waypoints Sequence"],"description":"Compute best Sequence for Waypoints (Travelling Salesman Problem).","operationId":"findSequenceGET_1","parameters":[{"name":"start","in":"query","description":"Waypoint to start the sequence.
Example:
&start=Munich;48.132777,11.565352","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"Waypoint to be reached at the end of the sequence. Usage is optional, but recommended.
Example:
&end=Paris;48.857397,2.346642","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"The routing mode determines how the route is calculated.
Type;TransportModes;TrafficMode;RouteFeature1,RouteFeature2
Calculation is limited to transport modes car, truck, bicycle, scooter, taxi, bus and pedestrian. Transport types are shortest and fastest. TrafficMode can be enabled or disabled. RouteFeatures can be used to avoid certain types of roads to a certain degree. Road features are: tollroad, motorway, boatFerry, railFerry, tunnel, dirtRoad, park. Usage of any such links can be restricted with values 0 (normal) to -4 (strict avoid). Delimiter between RouteFeatuers are commas.
Examples:
&mode=fastest;car;traffic:disabled;motorway:-2
&mode=fastest;car;traffic:enabled;motorway:-2,tollroad:-2","required":true,"schema":{"type":"string"}},{"name":"departure","in":"query","description":"Time when travel is expected to start. Traffic speed and incidents are taken into account when calculating the route. You can use now to specify the current time. Type: xs:dateTime.
Example:
&departure=2021-07-04T17:00:00+02:00","required":false,"schema":{"type":"string"}},{"name":"hasTrailer","in":"query","description":"Does the vehicle tow a trailer? Values: true/false","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","description":"0=None, 1=Caravan, 2=Trailer, 3=RVTrailer, 4=BoatTrailer. For toll cost and recreational vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","description":"Number of trailers, 0...4. For toll cost and truck restrictions. 0=no trailer, 1=one or more trailers, 2=two or more trailers, 3=three or more trailers. For truck restrictions: 4=one or more semi-trailers.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","description":"Number of axles excluding trailers. For toll cost and for country wide truck restrictions.
","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","description":"Number of trailer axles. For toll cost and for country wide truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","description":"1=fuel+electric, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","description":"1=EURO I, 2=EURO II, 3=EURO III, 4=EURO IV, 5=EURO V, 6=EURO VI, 7=EURO EEV, 8=Electric Vehicles, 9=EURO II with PRC, 10=EURO III with PRC. For toll cost and environmental zone restrictions, when emissionType is not specified it defaults to 5.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","description":"CO2 emission class of the vehicle. 1=Emission class 1, 2=Emission class 2, 3=Emission class 3, 4=Emission class 4, 5=Emission class 5. For toll cost only, when co2EmissionClass is not specified then it defaults to 1. Providing invalid combination of emissionType and co2EmissionClass in request may result in incorrect toll costs.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","description":"Actual height of the overall rigid/semi truck including trailers: 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","description":"Actual height of the trailer(s). 350cm or 3.5m or 138in. For toll cost only, not considered for route path creation (use height parameter)
(Not available for Waypoints Sequence).","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","description":"Actual total weight of vehicle incl. payload, but not trailers' weight or payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","description":"Actual total weight of vehicle incl. payload and trailers/caravan incl. their payload. 7.5t or 7500kg or 16500lbs. For truck restrictions, speed profile, toll cost and environmental zone restrictions. See also vehicleWeight. Note that country wide weight restrictions depend on the number of axles and trailers as well, so it might be necessary to specify them as well.","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Legal maximum weight limit of vehicle incl. payload and trailers. Also incl. their payload as a total. 7.5t or 7500kg or 16500lbs. For truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","description":"1=vehicle equipped to carry disabled people, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","description":"Actual number of passengers. For toll cost. See also vehicle type carHOV.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","description":"Number of tires. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","description":"1=vehicle registered for commercial use, 0=otherwise. For toll cost, environmental zone regulations and delivery-only zones.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","description":"Comma separated list from explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable. For toll cost (only explosive and other) and for truck restrictions. For Waypoints Sequence, allhazardousGoods and explosiveFlammable are not supported.","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","description":"350cm or 3.5m or 138in. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","description":"Length of the vehicle (including potential trailers). 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxle","in":"query","description":"Actual total weight per axle, incl. payload. 7.5t or 7500kg or 16500lbs (Waypoints Sequence in kg, no unit). For toll cost and truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"width","in":"query","description":"Width of the vehicle, e.g. 350cm or 3.5m or 138in. For truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"tunnelCategory","in":"query","description":"Defines the tunnel categories the truck must NOT use. B, C, D or E. A tunnels have no restrictions. E tunnels have most restrictions. If C is defined, the route will use A and B tunnels but not C, D or E.","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","description":"Defines the fuel powering the vehicle. Can be Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric. (LPG=Liquefied Petroleum Gas, LNG=Liquefied Natural Gas). Used f.e. for environmental zone restrictions, toll cost calculation, consumption based routing for Electric vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"weightPerAxleGroup","in":"query","description":"Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported names are drive, single, tandem, triple, quad, quint. Example: &weightPerAxleGroup=drive:12;single:11;tandem:18
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailerWeight","in":"query","description":"Actual total weight of trailers with their payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.","required":false,"schema":{"type":"string"}},{"name":"avoidSegments","in":"query","description":"Links which the route must not cross. The list of LinkIdTypes. LinkIdType is a xs:string with the following regular expression restrictions: [*-+]\\d+
Example:
&avoidLinks=-53623477","required":false,"schema":{"type":"string"}},{"name":"avoidAreas","in":"query","description":"Areas which the route must not cross. Array of up to 20 BoundingBox-es.
Example with two bounding boxes:
avoidAreas=52.517100760,13.3905424488;52.5169701849,13.391808451!52.517000760,13.3700424488;52.5168701849,13.371308451","required":false,"schema":{"type":"string"}},{"name":"excludeCountries","in":"query","description":"A list of three-letter country codes (ISO-3166-1 alpha-3 code) to be excluded from the underlying route calculations. Excluding countries near or between waypoints may result in incalculable routes.","required":false,"schema":{"type":"string"}},{"name":"avoidUTurns","in":"query","description":"This option avoids U-turns on highways and motorways. It is not supported for pedestrian, bicycle and scooter transport modes. Values: true/false. Default: false","required":false,"schema":{"type":"string"}},{"name":"improveFor","in":"query","description":"Measure to optimize. Values: distance,time. Default: time","required":false,"schema":{"type":"string"}},{"name":"jsonCallback","in":"query","description":"Specifies the function used to wrap the JSON response","required":false,"schema":{"type":"string"}},{"name":"requestId","in":"query","description":"Request Id returned in the response to match it with the request","required":false,"schema":{"type":"string","default":""}},{"name":"restTimes","in":"query","description":"Activates the accounting for rest times. Rest times are modelled with a short and a long cycle. Both cycles consist of a driving phase and a resting phase..
Also it can be specified if times at waypoint (service times) should be counted as
restTimes=durations:{short driving time in seconds},{short rest time in seconds},{long driving time in seconds},{long rest time in seconds;serviceTimes:work|rest.
Also the value can be set as default 'restTimes=default' which activates simplified European rules with 45min rest after 4.5h hours driving and 11h of long rest after 9h working, service times are accounted as work.
Example:
&restTimes=durations:16200,2700,32400,39600;serviceTimes:work","required":false,"schema":{"type":"string"}},{"name":"truckType","in":"query","description":"Truck routing only, specifies the vehicle type. Values:truck | tractorTruck, Defaults to truck. ","required":false,"schema":{"type":"string"}},{"name":"walkSpeed","in":"query","description":"Sets the speed (m/s), if the routing mode comes with 'pedestrian'","required":false,"schema":{"type":"string"}},{"name":"evChargingTimePerDistance","in":"query","description":"Activates accounting of times for charging electric vehicles. Requires a distance to be driven in Meter and the time in seconds required to recharge the energy required for the given distance.
Example:
evChargingTimePerDistance=7200,250000","required":false,"schema":{"type":"string"}},{"name":"clustering","in":"query","description":"The \"clustering\" parameter enables clustering of the waypoints. Two clustering algorithms are supported; drivingDistance and topologySegment.
The algorithm drivingDistance is a connectivity-based clustering algorithm where all waypoints of a cluster are within a driving distance of 50 meters of the specified vehicle in both directions. A custom value of the driving distance can be specified by drivingDistance:distanceInMeter.
The algorithm topologySegment creates a cluster of waypoints that can be map-matched to the same topology segment.
Examples:
&clustering=drivingDistance:100
&clustering=topologySegment","required":false,"schema":{"type":"string"}},{"name":"driverCost","in":"query","description":"Cost per hour in arbitrary currency.","required":false,"schema":{"type":"string"}},{"name":"vehicleCost","in":"query","description":"Cost per kilometer in arbitrary currency.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}},{"name":"destination0...destinationN or waypoint0...waypointN","in":"query","description":"There are two ways of specifying locations to be visited. Below is the documentation of destination0...destinationN.
Using the notation of waypoint0 ... waypointN switches the behavior of this endpoint to the find pickups scenario. This includes the availability, limitations and the syntax of the parameters.
For calculating other sequences using \"destination...\" is recommended.
Usage of destination0...destinationN:
A waypoint of this service contains an id, a set of latitude, longitude in WGS-84 degree and constraints, which may impose certain restrictions when calculating the sequence.
The format is [ID;]latitude,longitude[;st:{time in seconds}][[;acc:opening hours]|[;at:appointment]][;before:destinationNumber of other waypoint][;sideOfStreetHint:[matchSideOfStreet,]displayLatitude,displayLongitude].
The constraints are:
st: service time spent at the waypoint is seconds. Example: st:300
at: an appointment, requires the service time as the duration of the appointment. Example: at:2021-11-15T16:00:00+02:00;st:1800
acc: access hours when a destination can be visited. Requires a service time setting. Example: acc:mo12:00:00+02:00|fr18:00:00+02:00;st:900
before: referencing a destination which must be reached later. Example: before:7
acc and at cannot be used together on the same destination.
sideOfStreetHint: specifies the preferred side of street for the waypoint. It is typically the display location of an address or POI (point of interest) on the side of the road, available from Geocoder Search response. It consists of an optional parameter matchSideOfStreet and coordinates.
matchSideOfStreet determines how the hint would be handled. Possible values are:
'always' meaning the hint should always be used.
'onlyIfDivided' which means the hint should only be used on roads where traffic in opposite directions is divided; either there's a physical separation between lanes, or it's legally not allowed to cross them.
Default value for matchSideOfStreet is 'onlyIfDivided'
When retrieving the coordinates via the HERE Geocoding API, the navigational coordinates from the field \"access\" should be used for the latitude and longitude of a destination.
Examples:
&destination3=Berlin_appointment;52.51605,13.37691;at:2021-10-14T16:00:00+02:00;st:300
&destination11=Bratislava_limited_access;48.154722,17.145556;acc:tu06:00:00+02:00|tu20:00:00+02:00;st:900
&destination12=Copenhagen_long_servicetime;st:7200
&destination17=Malmo_before_Copenhagen55.600289,12.995798;before:12
&destination20=Frankfurt_market50.113029,8.683684;sideOfStreetHint:always,50.112970,8.683692","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/WseResponse"}}}}}},"post":{"tags":["Waypoints Sequence"],"description":"Compute best Sequence for Waypoints (Travelling Salesman Problem).","operationId":"findSequencePOST_1","parameters":[{"name":"start","in":"query","description":"Waypoint to start the sequence.
Example:
&start=Munich;48.132777,11.565352","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"Waypoint to be reached at the end of the sequence. Usage is optional, but recommended.
Example:
&end=Paris;48.857397,2.346642","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"The routing mode determines how the route is calculated.
Type;TransportModes;TrafficMode;RouteFeature1,RouteFeature2
Calculation is limited to transport modes car, truck, bicycle, scooter, taxi, bus and pedestrian. Transport types are shortest and fastest. TrafficMode can be enabled or disabled. RouteFeatures can be used to avoid certain types of roads to a certain degree. Road features are: tollroad, motorway, boatFerry, railFerry, tunnel, dirtRoad, park. Usage of any such links can be restricted with values 0 (normal) to -4 (strict avoid). Delimiter between RouteFeatuers are commas.
Examples:
&mode=fastest;car;traffic:disabled;motorway:-2
&mode=fastest;car;traffic:enabled;motorway:-2,tollroad:-2","required":true,"schema":{"type":"string"}},{"name":"departure","in":"query","description":"Time when travel is expected to start. Traffic speed and incidents are taken into account when calculating the route. You can use now to specify the current time. Type: xs:dateTime.
Example:
&departure=2021-07-04T17:00:00+02:00","required":false,"schema":{"type":"string"}},{"name":"hasTrailer","in":"query","description":"Does the vehicle tow a trailer? Values: true/false","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","description":"0=None, 1=Caravan, 2=Trailer, 3=RVTrailer, 4=BoatTrailer. For toll cost and recreational vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","description":"Number of trailers, 0...4. For toll cost and truck restrictions. 0=no trailer, 1=one or more trailers, 2=two or more trailers, 3=three or more trailers. For truck restrictions: 4=one or more semi-trailers.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","description":"Number of axles excluding trailers. For toll cost and for country wide truck restrictions.
","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","description":"Number of trailer axles. For toll cost and for country wide truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","description":"1=fuel+electric, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","description":"1=EURO I, 2=EURO II, 3=EURO III, 4=EURO IV, 5=EURO V, 6=EURO VI, 7=EURO EEV, 8=Electric Vehicles, 9=EURO II with PRC, 10=EURO III with PRC. For toll cost and environmental zone restrictions, when emissionType is not specified it defaults to 5.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","description":"CO2 emission class of the vehicle. 1=Emission class 1, 2=Emission class 2, 3=Emission class 3, 4=Emission class 4, 5=Emission class 5. For toll cost only, when co2EmissionClass is not specified then it defaults to 1. Providing invalid combination of emissionType and co2EmissionClass in request may result in incorrect toll costs.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","description":"Actual height of the overall rigid/semi truck including trailers: 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","description":"Actual height of the trailer(s). 350cm or 3.5m or 138in. For toll cost only, not considered for route path creation (use height parameter)
(Not available for Waypoints Sequence).","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","description":"Actual total weight of vehicle incl. payload, but not trailers' weight or payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","description":"Actual total weight of vehicle incl. payload and trailers/caravan incl. their payload. 7.5t or 7500kg or 16500lbs. For truck restrictions, speed profile, toll cost and environmental zone restrictions. See also vehicleWeight. Note that country wide weight restrictions depend on the number of axles and trailers as well, so it might be necessary to specify them as well.","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Legal maximum weight limit of vehicle incl. payload and trailers. Also incl. their payload as a total. 7.5t or 7500kg or 16500lbs. For truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","description":"1=vehicle equipped to carry disabled people, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","description":"Actual number of passengers. For toll cost. See also vehicle type carHOV.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","description":"Number of tires. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","description":"1=vehicle registered for commercial use, 0=otherwise. For toll cost, environmental zone regulations and delivery-only zones.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","description":"Comma separated list from explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable. For toll cost (only explosive and other) and for truck restrictions. For Waypoints Sequence, allhazardousGoods and explosiveFlammable are not supported.","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","description":"350cm or 3.5m or 138in. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","description":"Length of the vehicle (including potential trailers). 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxle","in":"query","description":"Actual total weight per axle, incl. payload. 7.5t or 7500kg or 16500lbs (Waypoints Sequence in kg, no unit). For toll cost and truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"width","in":"query","description":"Width of the vehicle, e.g. 350cm or 3.5m or 138in. For truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"tunnelCategory","in":"query","description":"Defines the tunnel categories the truck must NOT use. B, C, D or E. A tunnels have no restrictions. E tunnels have most restrictions. If C is defined, the route will use A and B tunnels but not C, D or E.","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","description":"Defines the fuel powering the vehicle. Can be Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric. (LPG=Liquefied Petroleum Gas, LNG=Liquefied Natural Gas). Used f.e. for environmental zone restrictions, toll cost calculation, consumption based routing for Electric vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"weightPerAxleGroup","in":"query","description":"Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported names are drive, single, tandem, triple, quad, quint. Example: &weightPerAxleGroup=drive:12;single:11;tandem:18
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailerWeight","in":"query","description":"Actual total weight of trailers with their payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.","required":false,"schema":{"type":"string"}},{"name":"avoidLinks","in":"query","description":"Links which the route must not cross. The list of LinkIdTypes. LinkIdType is a xs:string with the following regular expression restrictions: [*-+]\\d+
Example:
&avoidLinks=-53623477","required":false,"schema":{"type":"string"}},{"name":"avoidSegments","in":"query","description":"Links which the route must not cross. The list of LinkIdTypes. LinkIdType is a xs:string with the following regular expression restrictions: [*-+]\\d+
Example:
&avoidLinks=-53623477","required":false,"schema":{"type":"string"}},{"name":"avoidAreas","in":"query","description":"Areas which the route must not cross. Array of up to 20 BoundingBox-es.
Example with two bounding boxes:
avoidAreas=52.517100760,13.3905424488;52.5169701849,13.391808451!52.517000760,13.3700424488;52.5168701849,13.371308451","required":false,"schema":{"type":"string"}},{"name":"excludeCountries","in":"query","description":"A list of three-letter country codes (ISO-3166-1 alpha-3 code) to be excluded from the underlying route calculations. Excluding countries near or between waypoints may result in incalculable routes.","required":false,"schema":{"type":"string"}},{"name":"avoidUTurns","in":"query","description":"This option avoids U-turns on highways and motorways. It is not supported for pedestrian, bicycle and scooter transport modes. Values: true/false. Default: false","required":false,"schema":{"type":"string"}},{"name":"improveFor","in":"query","description":"Measure to optimize. Values: distance,time. Default: time","required":false,"schema":{"type":"string"}},{"name":"jsonCallback","in":"query","description":"Specifies the function used to wrap the JSON response","required":false,"schema":{"type":"string"}},{"name":"requestId","in":"query","description":"Request Id returned in the response to match it with the request","required":false,"schema":{"type":"string","default":""}},{"name":"restTimes","in":"query","description":"Activates the accounting for rest times. Rest times are modelled with a short and a long cycle. Both cycles consist of a driving phase and a resting phase..
Also it can be specified if times at waypoint (service times) should be counted as
restTimes=durations:{short driving time in seconds},{short rest time in seconds},{long driving time in seconds},{long rest time in seconds;serviceTimes:work|rest.
Also the value can be set as default 'restTimes=default' which activates simplified European rules with 45min rest after 4.5h hours driving and 11h of long rest after 9h working, service times are accounted as work.
Example:
&restTimes=durations:16200,2700,32400,39600;serviceTimes:work","required":false,"schema":{"type":"string"}},{"name":"truckType","in":"query","description":"Truck routing only, specifies the vehicle type. Values:truck | tractorTruck, Defaults to truck. ","required":false,"schema":{"type":"string"}},{"name":"walkSpeed","in":"query","description":"Truck routing only, specifies the vehicle type. Values:truck | tractorTruck, Defaults to truck. ","required":false,"schema":{"type":"string"}},{"name":"evChargingTimePerDistance","in":"query","description":"Activates accounting of times for charging electric vehicles. Requires a distance to be driven in Meter and the time in seconds required to recharge the energy required for the given distance.
Example:
evChargingTimePerDistance=7200,250000","required":false,"schema":{"type":"string"}},{"name":"clustering","in":"query","description":"The \"clustering\" parameter enables clustering of the waypoints. Two clustering algorithms are supported; drivingDistance and topologySegment.
The algorithm drivingDistance is a connectivity-based clustering algorithm where all waypoints of a cluster are within a driving distance of 50 meters of the specified vehicle in both directions. A custom value of the driving distance can be specified by drivingDistance:distanceInMeter.
The algorithm topologySegment creates a cluster of waypoints that can be map-matched to the same topology segment.
Examples:
&clustering=drivingDistance:100
&clustering=topologySegment","required":false,"schema":{"type":"string"}},{"name":"driverCost","in":"query","description":"Cost per hour in arbitrary currency.","required":false,"schema":{"type":"string"}},{"name":"vehicleCost","in":"query","description":"Cost per kilometer in arbitrary currency.","required":false,"schema":{"type":"string"}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}},{"name":"destination0...destinationN or waypoint0...waypointN","in":"query","description":"There are two ways of specifying locations to be visited. Below is the documentation of destination0...destinationN.
Using the notation of waypoint0 ... waypointN switches the behavior of this endpoint to the find pickups scenario. This includes the availability, limitations and the syntax of the parameters.
For calculating other sequences using \"destination...\" is recommended.
Usage of destination0...destinationN:
A waypoint of this service contains an id, a set of latitude, longitude in WGS-84 degree and constraints, which may impose certain restrictions when calculating the sequence.
The format is [ID;]latitude,longitude[;st:{time in seconds}][[;acc:opening hours]|[;at:appointment]][;before:destinationNumber of other waypoint][;sideOfStreetHint:[matchSideOfStreet,]displayLatitude,displayLongitude].
The constraints are:
st: service time spent at the waypoint is seconds. Example: st:300
at: an appointment, requires the service time as the duration of the appointment. Example: at:2021-11-15T16:00:00+02:00;st:1800
acc: access hours when a destination can be visited. Requires a service time setting. Example: acc:mo12:00:00+02:00|fr18:00:00+02:00;st:900
before: referencing a destination which must be reached later. Example: before:7
acc and at cannot be used together on the same destination.
sideOfStreetHint: specifies the preferred side of street for the waypoint. It is typically the display location of an address or POI (point of interest) on the side of the road, available from Geocoder Search response. It consists of an optional parameter matchSideOfStreet and coordinates.
matchSideOfStreet determines how the hint would be handled. Possible values are:
'always' meaning the hint should always be used.
'onlyIfDivided' which means the hint should only be used on roads where traffic in opposite directions is divided; either there's a physical separation between lanes, or it's legally not allowed to cross them.
Default value for matchSideOfStreet is 'onlyIfDivided'
When retrieving the coordinates via the HERE Geocoding API, the navigational coordinates from the field \"access\" should be used for the latitude and longitude of a destination.
Examples:
&destination3=Berlin_appointment;52.51605,13.37691;at:2021-10-14T16:00:00+02:00;st:300
&destination11=Bratislava_limited_access;48.154722,17.145556;acc:tu06:00:00+02:00|tu20:00:00+02:00;st:900
&destination12=Copenhagen_long_servicetime;st:7200
&destination17=Malmo_before_Copenhagen55.600289,12.995798;before:12
&destination20=Frankfurt_market50.113029,8.683684;sideOfStreetHint:always,50.112970,8.683692","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},"*/*":{"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/WseResponse"}}}}}}},"/v8/version":{"get":{"tags":["API Information"],"summary":"Version of the API","description":"Returns the version of the service.","operationId":"getVersion","parameters":[{"name":"X-Request-ID","in":"header","description":"User provided request identifier for tracking","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id","style":"simple"},"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id","style":"simple"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Version"}}}}}}},"/v8/maps/routeisoline":{"get":{"tags":["Map Attributes V8"],"summary":"Retrieve the POIs that are reachable within a certain time or distance from the main route","description":"Retrieve the POIs that are reachable within a certain time or distance from the main route","operationId":"searchRouteIsolineV8","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"layer_ids","in":"query","description":"Comma separated list of layer IDs to be searched. Layer names are not case sensitive. Both custom layers and PDE map layers are supported. PDE layers divided by functional class, like ROAD_GEOM_FC1 ... FC5 can be selected by N, e.g. ROAD_GEOM_FCN. Layers must have a LINK_ID column. If a customer doesn't have a LINK_ID column, customers can create it using the Geocoder, Reverse Geocoder or RME. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json","required":false,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"List of comma separated column names to specify which attributes shall appear in the result. Column names are not case sensitive. Default = all.","required":false,"schema":{"type":"string"}},{"name":"geom","in":"query","description":"local, full or none. Specifies the geometry representation in the result. Default = local. Local geometry is used for map display purposes, returning geometry pieces that cover the given search radius, bounding box or corridor polygon. Full geometry is used for interactive editing, where the original geometry is required. None is used for applications like geofencing, which most of the time want to know only the ids of the geofence points/lines polygons they are in or near.","required":false,"schema":{"type":"string","enum":["local","full","none"],"default":"local"}},{"name":"max_detour_distance","in":"query","description":"Either max_detour_distance or max_detour_time must be specified. Maximum travel distance in meter away from the route to reach the map object. This is one way, from the junction that leaves the route until to the map object. The distance to get back onto the route is not considered here.","required":false,"schema":{"type":"number","format":"double"}},{"name":"max_detour_time","in":"query","description":"Either max_detour_time or max_detour_distance\tMaximum travel time in seconds away from the route to reach the map object. This is one way, from the junction that leaves the route until to the map object. The time to get back onto the route is not considered here.","required":false,"schema":{"type":"number","format":"double"}},{"name":"storage","in":"query","description":"Optional, default searches in both. Specify 'updatable' or 'readonly', how you uploaded the layer.","required":false,"schema":{"type":"string","default":"updatable"}},{"name":"mapMatchRadius","in":"query","description":"Maximum adaptive map match search radius [meter]. Will be applied to each way point. If given it overrides waypoints' transitRadius values and the default maximum adaptive search radius. For routing, default 1600. Limit 5000.","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","description":"0=None, 1=Caravan, 2=Trailer, 3=RVTrailer, 4=BoatTrailer. For toll cost and recreational vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","description":"Number of trailers, 0...4. For toll cost and truck restrictions. 0=no trailer, 1=one or more trailers, 2=two or more trailers, 3=three or more trailers. For truck restrictions: 4=one or more semi-trailers.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","description":"Number of axles excluding trailers. For toll cost and for country wide truck restrictions.
","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","description":"Number of trailer axles. For toll cost and for country wide truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","description":"1=fuel+electric, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","description":"1=EURO I, 2=EURO II, 3=EURO III, 4=EURO IV, 5=EURO V, 6=EURO VI, 7=EURO EEV, 8=Electric Vehicles, 9=EURO II with PRC, 10=EURO III with PRC. For toll cost and environmental zone restrictions, when emissionType is not specified it defaults to 5.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","description":"CO2 emission class of the vehicle. 1=Emission class 1, 2=Emission class 2, 3=Emission class 3, 4=Emission class 4, 5=Emission class 5. For toll cost only, when co2EmissionClass is not specified then it defaults to 1. Providing invalid combination of emissionType and co2EmissionClass in request may result in incorrect toll costs.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","description":"Actual height of the overall rigid/semi truck including trailers: 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","description":"Actual height of the trailer(s). 350cm or 3.5m or 138in. For toll cost only, not considered for route path creation (use height parameter)
(Not available for Waypoints Sequence).","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","description":"Actual total weight of vehicle incl. payload, but not trailers' weight or payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","description":"Actual total weight of vehicle incl. payload and trailers/caravan incl. their payload. 7.5t or 7500kg or 16500lbs. For truck restrictions, speed profile, toll cost and environmental zone restrictions. See also vehicleWeight. Note that country wide weight restrictions depend on the number of axles and trailers as well, so it might be necessary to specify them as well.","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Legal maximum weight limit of vehicle incl. payload and trailers. Also incl. their payload as a total. 7.5t or 7500kg or 16500lbs. For truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","description":"1=vehicle equipped to carry disabled people, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","description":"Actual number of passengers. For toll cost. See also vehicle type carHOV.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","description":"Number of tires. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","description":"1=vehicle registered for commercial use, 0=otherwise. For toll cost, environmental zone regulations and delivery-only zones.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","description":"Comma separated list from explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable. For toll cost (only explosive and other) and for truck restrictions. For Waypoints Sequence, allhazardousGoods and explosiveFlammable are not supported.","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","description":"350cm or 3.5m or 138in. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","description":"Length of the vehicle (including potential trailers). 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxle","in":"query","description":"Actual total weight per axle, incl. payload. 7.5t or 7500kg or 16500lbs (Waypoints Sequence in kg, no unit). For toll cost and truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"width","in":"query","description":"Width of the vehicle, e.g. 350cm or 3.5m or 138in. For truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"tunnelCategory","in":"query","description":"Defines the tunnel categories the truck must NOT use. B, C, D or E. A tunnels have no restrictions. E tunnels have most restrictions. If C is defined, the route will use A and B tunnels but not C, D or E.","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","description":"Defines the fuel powering the vehicle. Can be Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric. (LPG=Liquefied Petroleum Gas, LNG=Liquefied Natural Gas). Used f.e. for environmental zone restrictions, toll cost calculation, consumption based routing for Electric vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"weightPerAxleGroup","in":"query","description":"Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported names are drive, single, tandem, triple, quad, quint. Example: &weightPerAxleGroup=drive:12;single:11;tandem:18
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailerWeight","in":"query","description":"Actual total weight of trailers with their payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.","required":false,"schema":{"type":"string"}},{"name":"region","in":"query","description":"Optional (default=whole world excl. JPN, CHN, SK). Map coverage region, e.g. APAC, AUS, WEU, IND, MEA, NA, SAM, TWN, JPN. The region may contain hints to distinguish specific content. E.g. there can be an WEU and PCBEU, where the 2nd map contains only Postal Code Boundary layers. If not specified, the service will find the region(s) automatically, that cover the request. The parameter can contain a comma separated list of regions (f.e. WEU,MEA). If the region parameter is specified, the service will use these region(s) and skip region(s) that may also cover the response (f.e. EEU). Except of JPN, specifying a region is strongly discouraged, because regions might change and hence applications that specify a region might stop working when the region gets discontinued, renamed, split or changed otherwise. As the APAC region contains a simplified entry map content of JPN, JPN needs to be specified as region to access the full JPN content.","required":false,"schema":{"type":"string"}},{"name":"language","in":"query","required":false,"schema":{"type":"string"}},{"name":"map_name","in":"query","description":"Optional. Map within to look for the layer. Default: Look into the default map.","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"linkAttributes","in":"query","description":"Define optional attributes to be returned for each link. Currently supported: cost.","required":false,"schema":{"type":"string"}},{"name":"searchInterval","in":"query","description":"Specifies in which intervals route isoline POIs are requested. Defined as from/to elapsed time on the route &searchInterval=fromSeconds,ToSeconds,FromSeconds,ToSeconds,...","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"The routing mode (e.g. fastest;car;traffic:disabled) that determines how the route is calculated.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"waypoint0 ... waypointN","in":"query","description":"Either waypoints or route_id must be specified. Comma separated waypoint latitude, longitude in WGS-84 degree. A route must consist of at least 2\r\nwaypoints (start and destination). The maximum number of waypoints is limited. However, this limit is\r\nnot a fixed number but is a result of the limit for the overall processing time. To define a loading/delay\r\ntime at a waypoint, use stopOver[,timeInSeconds]!. Example: &waypoint1=stopOver,300!50.12,8.65.\r\nNone of the optional specifications geo!, stopOver!, passThrough!, altitude,\r\ntransitRadius, custom label, heading, !StreetPosition, !LinkPosition are currently supported.","required":true,"schema":{"type":"string"}},{"name":"apikey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/GeometrySearchResponse"}}}}}}},"/v8/maps/list":{"get":{"tags":["Map Attributes V8"],"summary":"List available map (public/private/both) regions/releases available to the app.","operationId":"v8MapsListJSON","parameters":[{"name":"mapName","in":"query","description":"map name. Optional for public HERE maps and for private BYOD maps. If specified, all versions of specified map is retrieved","required":false,"schema":{"type":"string"}},{"name":"mapType","in":"query","description":"Option to filter maps to be listed based on whether they are public, private or both, default value 0: both private and public maps, 1: only public maps, 2: only private maps","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/MapDocResponse"}}}}}}},"/v8/maps/list.html":{"get":{"tags":["Map Attributes V8"],"summary":"List all maps (public/private/both) available to the app in HTML format.","operationId":"v8MapsListHTML","parameters":[{"name":"mapName","in":"query","description":"map name. Optional for public HERE maps and for private BYOD maps. If specified, all versions of specified map is retrieved","required":false,"schema":{"type":"string"}},{"name":"mapType","in":"query","description":"Option to filter maps to be listed based on whether they are public, private or both, default value 0: both private and public maps, 1: only public maps, 2: only private maps","required":false,"schema":{"type":"string"}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/html;charset=UTF-8":{"schema":{"type":"string"}}}}}}},"/v8/maps/layers/list":{"get":{"tags":["Map Attributes V8"],"summary":"List the available map layers (public/private/both) in JSON format. To see only the layers of a given map region, like Postal Code Boundaries or WEU, then specify it as map 'region'","operationId":"v8LayersListJSON","parameters":[{"name":"mapName","in":"query","description":"map name. Optional for public HERE maps and for private BYOD maps. If not specified, the layers of all maps are retrieved","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"layerType","in":"query","description":"Option to filter layers to be listed based on whether they are public, private or both, default value 0: both private and public layers, 1: only public layers, 2: only private layers","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LayerDocBean"}}}}}}}},"/v8/maps/layers/list.html":{"get":{"tags":["Map Attributes V8"],"summary":"List the available map layers (public/private/both) in HTML format. To see only the layers of a given map region, like Postal Code Boundaries or WEU, then specify it as map 'region'","operationId":"v8LayersListHTML","parameters":[{"name":"mapName","in":"query","description":"map name. Optional for public HERE maps and for private BYOD maps. If not specified, the layers of all maps are retrieved","required":false,"schema":{"type":"string"}},{"name":"layerType","in":"query","description":"Option to filter layers to be listed based on whether they are public, private or both, default value 0: both private and public layers, 1: only public layers, 2: only private layers","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/html;charset=UTF-8":{"schema":{"type":"string"}}}}}}},"/v8/maps/layers/doc":{"get":{"tags":["Map Attributes V8"],"summary":"Show the layer documentation for a specific layer (public/private) in JSON format. Public layer documentation list the attributes and corresponding official attribute description, for private layers attribute description might be empty.","operationId":"v8LayerDocJSON","parameters":[{"name":"layer","in":"query","required":true,"schema":{"type":"string"}},{"name":"mapName","in":"query","description":"map name. Optional for public HERE maps and for private BYOD maps. If not specified, the layer doc available in all maps are retrieved","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LayerDetailDocBean"}}}}}}}},"/v8/maps/layers/doc.html":{"get":{"tags":["Map Attributes V8"],"summary":"Show the layer documentation for a specific layer (public/private) in HTML format. Public layer documentation list the attributes and corresponding official attribute description, for private layers attribute description might be empty.","operationId":"v8LayerDocHTML","parameters":[{"name":"layer","in":"query","required":true,"schema":{"type":"string"}},{"name":"mapName","in":"query","description":"map name. Optional for public HERE maps and for private BYOD maps. If not specified, the layer doc available in all maps are retrieved","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/html;charset=UTF-8":{"schema":{"type":"string"}}}}}}},"/v8/maps/layers/attributes":{"get":{"tags":["Map Attributes V8"],"summary":"List the layer attributes across all layers","description":"List the map layer attributes across all layers","operationId":"v8LayerAttributesJSON","parameters":[{"name":"mapName","in":"query","description":"map name. Optional for public HERE maps and for private BYOD maps. If not given, the layer attributes of all maps are retrieved","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AttributeDocBean"}}}}}}}},"/v8/maps/layers/attributes.html":{"get":{"tags":["Map Attributes V8"],"summary":"List the layer attributes across all layers","description":"List the layer attributes across all layers in basic HTML format","operationId":"v8LayerAttributesHTML","parameters":[{"name":"mapName","in":"query","description":"map name. Optional for public HERE maps and for private BYOD maps. If not given, the layer attributes of all maps are retrieved","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/html;charset=UTF-8":{"schema":{"type":"string"}}}}}}},"/v8/maps/indexes":{"get":{"tags":["Map Attributes V8"],"summary":"List available layer indexes","description":"List the available indexes of custom and public layers.","operationId":"v8MapIndexesJSON","parameters":[{"name":"mapName","in":"query","description":"map name. Optional for public HERE maps and for private BYOD maps. If not given, the content from all maps is retrieved","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndexDocBean"}}}}}}}},"/v8/maps/indexes.html":{"get":{"tags":["Map Attributes V8"],"summary":"List available layer indexes","description":"List the available indexes of custom and public layers.","operationId":"v8MapIndexesHTML","parameters":[{"name":"mapName","in":"query","description":"map name. Optional for public HERE maps and for private BYOD maps. If not given, the content from all maps is retrieved","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/html;charset=UTF-8":{"schema":{"type":"string"}}}}}}},"/v8/maps/index":{"get":{"tags":["Map Attributes V8"],"summary":"Tile IDs containing a given value","description":"Retrieve the IDs of tiles that contain a given (set of) attribute value(s). Does not work for custom layers.","operationId":"v8Index","parameters":[{"name":"layer","in":"query","description":"layer name","required":true,"schema":{"type":"string"}},{"name":"mapName","in":"query","description":"map name. Optional for public HERE maps and for private BYOD maps. If not specified, the content of all maps is retrieved","required":false,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"comma separated list of the index attribute names","required":false,"schema":{"type":"string"}},{"name":"values","in":"query","description":"comma separated list of index attribute values, corresponding to the attribute names","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apiKey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/IndexResponse"}}}}}}},"/v8/maps/file.bin":{"get":{"tags":["Map Attributes V8"],"summary":"File content","description":"Retrieve the binary content of a file, like a junction view image","operationId":"v8GetFile","parameters":[{"name":"mapName","in":"query","description":"map name. Optional for public HERE maps and for private BYOD maps. If not specified, the content of all maps is retrieved","required":false,"schema":{"type":"string"}},{"name":"layer","in":"query","description":"layer name","required":false,"schema":{"type":"string"}},{"name":"path","in":"query","description":"file path, as specified in the referencing layer's attribute value","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"type":"string"}}}}}}},"/v8/maps/delete":{"get":{"tags":["Map Attributes V8"],"summary":"Delete some of my Geometry Layers. To delete complete maps and overlays, leave the layerNames field in parameter 'id' empty - deprecated","operationId":"v8DeleteMapsLayers","parameters":[{"name":"layerId","in":"query","description":"Unique identifier for the layer in the format {app_id}.{mapName}.{layerNames}. app_id: app_id of the project under which the layers exit; mapName: delete the layers within this map, default = delete the layers in app_id's default map; layerNames: Comma separated name of layers to delete. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json.","required":true,"schema":{"type":"string"}},{"name":"storage","in":"query","description":"Either updatable or readonly. Default = updatable. Only updatable layers can be deleted, for readonly layers and overlays complete map containing the layer should be deleted.","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteLayersResponse"}}}}}}},"/v8/maps/content.html":{"get":{"tags":["Map Attributes V8"],"summary":"Landing page for inline documentation","description":"Landing page for inline documentation in HTML format","operationId":"v8ContentHTML","parameters":[{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","description":"One of three authentication methods to choose from. A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html .
Other Options are Bearer, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"text/html;charset=UTF-8":{"schema":{"type":"string"}}}}}}},"/v8/health":{"get":{"tags":["API Information"],"summary":"Health status of the service","description":"Returns the health of the service.","operationId":"getHealth","parameters":[{"name":"X-Request-ID","in":"header","description":"User provided request identifier for tracking","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id","style":"simple"},"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id","style":"simple"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthStatus"}}}}}}},"/v8/geofence/delete":{"get":{"tags":["Geofencing V8"],"summary":"Delete some of my Geometry Layers. To delete complete maps, leave the layerNames field in parameter 'id' empty","operationId":"v8DeleteMapsLayers_1","parameters":[{"name":"layerId","in":"query","description":"Unique identifier for the layer in the format {app_id}.{mapName}.{layerNames}. app_id: app_id of the project under which the layers exit; mapName: delete the layers within this map, default = delete the layers in app_id's default map; layerNames: Comma separated name of layers to delete. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json.","required":true,"schema":{"type":"string"}},{"name":"storage","in":"query","description":"Either updatable or readonly. Default = updatable. Only updatable layers can be deleted, for readonly layers and overlays complete map containing the layer should be deleted.","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteLayersResponse"}}}}}}},"/v3/api-docs.yaml":{"get":{"tags":["API Information"],"summary":"Open API specification","description":"Returns Open API specification in YAML format.","operationId":"generateApiDocsInYamlFormat","parameters":[{"name":"X-Request-ID","in":"header","description":"User provided request identifier for tracking","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id","style":"simple"},"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id","style":"simple"}},"content":{"text/yaml;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/OpenapiResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/OpenapiResponse"}}}}}}},"/v8/openapi":{"get":{"tags":["API Information"],"summary":"Open API specification","description":"Returns Open API specification in YAML format.","operationId":"generateApiDocsInYamlFormat_1","parameters":[{"name":"X-Request-ID","in":"header","description":"User provided request identifier for tracking","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id","style":"simple"},"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id","style":"simple"}},"content":{"text/yaml;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/OpenapiResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/OpenapiResponse"}}}}}}},"/2/search/routeisoline.json":{"get":{"tags":["Search"],"summary":"Retrieve the POIs that are reachable within a certain time or distance from the main route","operationId":"searchRouteIsoline","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"layer_ids","in":"query","description":"Comma separated list of layer IDs to be searched. Layer names are not case sensitive. Both custom layers and PDE map layers are supported. PDE layers divided by functional class, like ROAD_GEOM_FC1 ... FC5 can be selected by N, e.g. ROAD_GEOM_FCN. Layers must have a LINK_ID column. If a customer doesn't have a LINK_ID column, customers can create it using the Geocoder, Reverse Geocoder or RME. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json","required":false,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"List of comma separated column names to specify which attributes shall appear in the result. Column names are not case sensitive. Default = all.","required":false,"schema":{"type":"string"}},{"name":"geom","in":"query","description":"local, full or none. Specifies the geometry representation in the result. Default = local. Local geometry is used for map display purposes, returning geometry pieces that cover the given search radius, bounding box or corridor polygon. Full geometry is used for interactive editing, where the original geometry is required. None is used for applications like geofencing, which most of the time want to know only the ids of the geofence points/lines polygons they are in or near.","required":false,"schema":{"type":"string","enum":["local","full","none"],"default":"local"}},{"name":"max_detour_distance","in":"query","description":"Either max_detour_distance or max_detour_time must be specified. Maximum travel distance in meter away from the route to reach the map object. This is one way, from the junction that leaves the route until to the map object. The distance to get back onto the route is not considered here.","required":false,"schema":{"type":"number","format":"double"}},{"name":"max_detour_time","in":"query","description":"Either max_detour_time or max_detour_distance\tMaximum travel time in seconds away from the route to reach the map object. This is one way, from the junction that leaves the route until to the map object. The time to get back onto the route is not considered here.","required":false,"schema":{"type":"number","format":"double"}},{"name":"storage","in":"query","description":"Optional, default searches in both. Specify 'updatable' or 'readonly', how you uploaded the layer.","required":false,"schema":{"type":"string","default":"updatable"}},{"name":"mapMatchRadius","in":"query","description":"Maximum adaptive map match search radius [meter]. Will be applied to each way point. If given it overrides waypoints' transitRadius values and the default maximum adaptive search radius. For routing, default 1600. Limit 5000.","required":false,"schema":{"type":"string"}},{"name":"region","in":"query","description":"Optional (default=whole world excl. JPN, CHN, SK). Map coverage region, e.g. APAC, AUS, WEU, IND, MEA, NA, SAM, TWN, JPN. The region may contain hints to distinguish specific content. E.g. there can be an WEU and PCBEU, where the 2nd map contains only Postal Code Boundary layers. If not specified, the service will find the region(s) automatically, that cover the request. The parameter can contain a comma separated list of regions (f.e. WEU,MEA). If the region parameter is specified, the service will use these region(s) and skip region(s) that may also cover the response (f.e. EEU). Except of JPN, specifying a region is strongly discouraged, because regions might change and hence applications that specify a region might stop working when the region gets discontinued, renamed, split or changed otherwise. As the APAC region contains a simplified entry map content of JPN, JPN needs to be specified as region to access the full JPN content.","required":false,"schema":{"type":"string"}},{"name":"language","in":"query","required":false,"schema":{"type":"string"}},{"name":"map_name","in":"query","description":"Optional. Map within to look for the layer. Default: Look into the default map.","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"linkAttributes","in":"query","description":"Define optional attributes to be returned for each link. Currently supported: cost.","required":false,"schema":{"type":"string"}},{"name":"searchInterval","in":"query","description":"Specifies in which intervals route isoline POIs are requested. Defined as from/to elapsed time on the route &searchInterval=fromSeconds,ToSeconds,FromSeconds,ToSeconds,...","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"The routing mode (e.g. fastest;car;traffic:disabled) that determines how the route is calculated.","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","description":"0=None, 1=Caravan, 2=Trailer, 3=RVTrailer, 4=BoatTrailer. For toll cost and recreational vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","description":"Number of trailers, 0...4. For toll cost and truck restrictions. 0=no trailer, 1=one or more trailers, 2=two or more trailers, 3=three or more trailers. For truck restrictions: 4=one or more semi-trailers.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","description":"Number of axles excluding trailers. For toll cost and for country wide truck restrictions.
","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","description":"Number of trailer axles. For toll cost and for country wide truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","description":"1=fuel+electric, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","description":"1=EURO I, 2=EURO II, 3=EURO III, 4=EURO IV, 5=EURO V, 6=EURO VI, 7=EURO EEV, 8=Electric Vehicles, 9=EURO II with PRC, 10=EURO III with PRC. For toll cost and environmental zone restrictions, when emissionType is not specified it defaults to 5.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","description":"CO2 emission class of the vehicle. 1=Emission class 1, 2=Emission class 2, 3=Emission class 3, 4=Emission class 4, 5=Emission class 5. For toll cost only, when co2EmissionClass is not specified then it defaults to 1. Providing invalid combination of emissionType and co2EmissionClass in request may result in incorrect toll costs.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","description":"Actual height of the overall rigid/semi truck including trailers: 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","description":"Actual height of the trailer(s). 350cm or 3.5m or 138in. For toll cost only, not considered for route path creation (use height parameter)
(Not available for Waypoints Sequence).","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","description":"Actual total weight of vehicle incl. payload, but not trailers' weight or payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","description":"Actual total weight of vehicle incl. payload and trailers/caravan incl. their payload. 7.5t or 7500kg or 16500lbs. For truck restrictions, speed profile, toll cost and environmental zone restrictions. See also vehicleWeight. Note that country wide weight restrictions depend on the number of axles and trailers as well, so it might be necessary to specify them as well.","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Legal maximum weight limit of vehicle incl. payload and trailers. Also incl. their payload as a total. 7.5t or 7500kg or 16500lbs. For truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","description":"1=vehicle equipped to carry disabled people, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","description":"Actual number of passengers. For toll cost. See also vehicle type carHOV.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","description":"Number of tires. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","description":"1=vehicle registered for commercial use, 0=otherwise. For toll cost, environmental zone regulations and delivery-only zones.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","description":"Comma separated list from explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable. For toll cost (only explosive and other) and for truck restrictions. For Waypoints Sequence, allhazardousGoods and explosiveFlammable are not supported.","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","description":"350cm or 3.5m or 138in. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","description":"Length of the vehicle (including potential trailers). 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxle","in":"query","description":"Actual total weight per axle, incl. payload. 7.5t or 7500kg or 16500lbs (Waypoints Sequence in kg, no unit). For toll cost and truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"width","in":"query","description":"Width of the vehicle, e.g. 350cm or 3.5m or 138in. For truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"tunnelCategory","in":"query","description":"Defines the tunnel categories the truck must NOT use. B, C, D or E. A tunnels have no restrictions. E tunnels have most restrictions. If C is defined, the route will use A and B tunnels but not C, D or E.","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","description":"Defines the fuel powering the vehicle. Can be Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric. (LPG=Liquefied Petroleum Gas, LNG=Liquefied Natural Gas). Used f.e. for environmental zone restrictions, toll cost calculation, consumption based routing for Electric vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"weightPerAxleGroup","in":"query","description":"Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported names are drive, single, tandem, triple, quad, quint. Example: &weightPerAxleGroup=drive:12;single:11;tandem:18
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailerWeight","in":"query","description":"Actual total weight of trailers with their payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"waypoint0 ... waypointN","in":"query","description":"Either waypoints or route_id must be specified. Comma separated waypoint latitude, longitude in WGS-84 degree. A route must consist of at least 2\r\nwaypoints (start and destination). The maximum number of waypoints is limited. However, this limit is\r\nnot a fixed number but is a result of the limit for the overall processing time. To define a loading/delay\r\ntime at a waypoint, use stopOver[,timeInSeconds]!. Example: &waypoint1=stopOver,300!50.12,8.65.\r\nNone of the optional specifications geo!, stopOver!, passThrough!, altitude,\r\ntransitRadius, custom label, heading, !StreetPosition, !LinkPosition are currently supported.","required":true,"schema":{"type":"string"}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/GeometrySearchResponse"}}}}}}},"/2/search/quadkey.json":{"get":{"tags":["Search"],"summary":"Retrieve custom layer content within a quadkey","description":"Retrieve the layer content records within a given geo rectangle specified by a (standard WGS84 Mercator) quadkey in custom layers.","operationId":"searchQuadKey","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"layer_id","in":"query","description":"Layer ID identifying the layers to be searched. Layer names are not case sensitive. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json","required":true,"schema":{"type":"string"}},{"name":"quad_key","in":"query","description":"The quad key number of the map tile area to search from.","required":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"A JavaScript expression being evaluated for each geometry matching search query.\r\nColumns value for the geometry are available as defined variables.\r\nWhen specified, only geometries where expression evaluates to true will be returned.\r\nExample: filter=RATING > 3 && NAME != 'MyPlace23' && NAME.startsWith('Food')\r\nParameter value must be url encoded when using special characters.\r\nThis filter expression is applied after the spatial filtering, hence only to few geometries. Only for the all.json the filter is applied to all geometries, so it can become very slow for big layers. Hence, following substring search expressions use database indexes and are much faster than other filter expressions (for updatable layers):\r\nCOL_NAME.indexOf(\"my_substring\") >= 0\r\nCOL_NAME.startsWith(\"my_prefix\")\r\nCOL_NAME == \"str\"\r\nCOL_NAME === \"str\"\r\nCOL_NAME != \"str\"\r\nCOL_NAME !== \"str\"\r\nCOL_NAME.indexOf(\"str\") >= 0\r\nCOL_NAME.startsWith(\"str\")\r\nCOL_NAME.like(\"%str%\")\r\nTo avoid service overload, filter expressions must not exceed 100 characters of text and their execution on the result must not exceed 100 ms execution time.","required":false,"schema":{"type":"string","default":""}},{"name":"geom","in":"query","description":"local, full or none. Specifies the geometry representation in the result. Default = local. Local geometry is used for map display purposes, returning geometry pieces that cover the given search radius, bounding box or corridor polygon. Full geometry is used for interactive editing, where the original geometry is required. None is used for applications like geofencing, which most of the time want to know only the ids of the geofence points/lines polygons they are in or near.","required":false,"schema":{"type":"string","enum":["local","full","none"],"default":"local"}},{"name":"storage","in":"query","description":"Optional, default searches in both. Specify 'updatable' or 'readonly', how you uploaded the layer.","required":false,"schema":{"type":"string","default":"updatable"}},{"name":"map_name","in":"query","description":"Optional. Map within to look for the layer. Default: Look into the default map.","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"owner_app_id","in":"query","description":"Owner app_id that was used to upload the custom layer.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/GeometrySearchResponse"}}}}}}},"/2/search/proximity.json":{"get":{"tags":["Search"],"summary":"Search for geometries within a radius around a given coordinate in custom layers","operationId":"searchProximity","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"layer_ids","in":"query","description":"Comma separated list of layer IDs to be searched. Layer names are not case sensitive. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json","required":true,"schema":{"type":"string"}},{"name":"proximity","in":"query","description":"The circular search area specified by center latitude, longitude [WGS84 degrees], radius [meter].\r\nAll geometries overlapping this circle will be returned, sorted by distance, closest first.\r\nExample: proximity=47.731,7.5549,100\r\nMultiple coordinate pairs can be passed as a semicolon separated list. For each of them, the layer_ids list is searched. If each coordinate pair is searched in a different set of layers, layer_ids contains a semicolon separated list of (comma separated list of) layers.","required":true,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"List of comma separated column names to specify which attributes shall appear in the result. Column names are not case sensitive. Default = all.","required":false,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"A JavaScript expression being evaluated for each geometry matching search query.\r\nColumns value for the geometry are available as defined variables.\r\nWhen specified, only geometries where expression evaluates to true will be returned.\r\nExample: filter=RATING > 3 && NAME != 'MyPlace23' && NAME.startsWith('Food')\r\nParameter value must be url encoded when using special characters.\r\nThis filter expression is applied after the spatial filtering, hence only to few geometries. Only for the all.json the filter is applied to all geometries, so it can become very slow for big layers. Hence, following substring search expressions use database indexes and are much faster than other filter expressions (for updatable layers):\r\nCOL_NAME.indexOf(\"my_substring\") >= 0\r\nCOL_NAME.startsWith(\"my_prefix\")\r\nCOL_NAME == \"str\"\r\nCOL_NAME === \"str\"\r\nCOL_NAME != \"str\"\r\nCOL_NAME !== \"str\"\r\nCOL_NAME.indexOf(\"str\") >= 0\r\nCOL_NAME.startsWith(\"str\")\r\nCOL_NAME.like(\"%str%\")\r\nTo avoid service overload, filter expressions must not exceed 100 characters of text and their execution on the result must not exceed 100 ms execution time.","required":false,"schema":{"type":"string","default":""}},{"name":"geom","in":"query","description":"local, full or none. Specifies the geometry representation in the result. Default = local. Local geometry is used for map display purposes, returning geometry pieces that cover the given search radius, bounding box or corridor polygon. Full geometry is used for interactive editing, where the original geometry is required. None is used for applications like geofencing, which most of the time want to know only the ids of the geofence points/lines polygons they are in or near.","required":false,"schema":{"type":"string","enum":["local","full","none"],"default":"local"}},{"name":"storage","in":"query","description":"Optional, default searches in both. Specify 'updatable' or 'readonly', how you uploaded the layer.","required":false,"schema":{"type":"string","default":"updatable"}},{"name":"map_name","in":"query","description":"Optional. Map within to look for the layer. Default: Look into the default map.","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"release","in":"query","description":"To choose a specific snapshot of the weather archive layer, a UNIX timestamp (number of milliseconds since 1970) or a date in 2017-12-01T17:30:00+01:00 format can be passed.","required":false,"schema":{"type":"string"}},{"name":"owner_app_id","in":"query","description":"Owner app_id that was used to upload the custom layer.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/GeometrySearchResponse"}}}}}}},"/2/search/proximities.json":{"get":{"tags":["Search"],"summary":"Search the POIs within a given circle - multiple POI layers with different circles can be specified","operationId":"searchProximities","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"geom","in":"query","description":"local, full or none. Specifies the geometry representation in the result. Default = local. Local geometry is used for map display purposes, returning geometry pieces that cover the given search radius, bounding box or corridor polygon. Full geometry is used for interactive editing, where the original geometry is required. None is used for applications like geofencing, which most of the time want to know only the ids of the geofence points/lines polygons they are in or near.","required":false,"schema":{"type":"string","enum":["local","full","none"],"default":"local"}},{"name":"storage","in":"query","description":"Optional, default searches in both. Specify 'updatable' or 'readonly', how you uploaded the layer.","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"owner_app_id","in":"query","description":"Owner app_id that was used to upload the custom layer.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"proximity0 ... proximityN","in":"query","description":"Defines the parameters for a proximity search. This includes the geometry of the search and other parameters. Geometry and other parameters are separated by semicolons.\r\n * The geometry is defined as comma separated waypoint latitude, longitude in WGS-84 degree and radius in Meter.\r\n * layer: List of comma separated layer names to be searched. Layer names are not case sensitive.\r\n * mapName: a map or a region. Default: a geographically suitable map which includes the given layer\r\n * keyAttribute: Unique identifier per object. Use GEOMETRY_ID for private maps without other unique id. Check the online documentation for key attributes of public maps (id-like entries).\r\n * attributes: List of comma separated column names to specify which attributes shall appear in the result. Column names are not case sensitive. Optional, default = all.\r\n","required":true,"schema":{"type":"string"}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/GeometrySearchResponse"}}}}}}},"/2/search/bbox.json":{"get":{"tags":["Search"],"description":"Search for geometries in a given rectangle within custom layers","operationId":"searchBoundingBox","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"layer_id","in":"query","description":"Layer ID identifying the layers to be searched. Layer names are not case sensitive. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json","required":true,"schema":{"type":"string"}},{"name":"bbox","in":"query","description":"A bounding box, provided as upper, left, lower and right coordinates in WGS84 degrees. All geometries overlapping this rectangle will be returned.\r\nThe format is north latitude,west longitude;south latitude,east longitude.\r\nExample: bbox=37.8,-122.1;37.2,-122.0","required":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"A JavaScript expression being evaluated for each geometry matching search query.\r\nColumns value for the geometry are available as defined variables.\r\nWhen specified, only geometries where expression evaluates to true will be returned.\r\nExample: filter=RATING > 3 && NAME != 'MyPlace23' && NAME.startsWith('Food')\r\nParameter value must be url encoded when using special characters.\r\nThis filter expression is applied after the spatial filtering, hence only to few geometries. Only for the all.json the filter is applied to all geometries, so it can become very slow for big layers. Hence, following substring search expressions use database indexes and are much faster than other filter expressions (for updatable layers):\r\nCOL_NAME.indexOf(\"my_substring\") >= 0\r\nCOL_NAME.startsWith(\"my_prefix\")\r\nCOL_NAME == \"str\"\r\nCOL_NAME === \"str\"\r\nCOL_NAME != \"str\"\r\nCOL_NAME !== \"str\"\r\nCOL_NAME.indexOf(\"str\") >= 0\r\nCOL_NAME.startsWith(\"str\")\r\nCOL_NAME.like(\"%str%\")\r\nTo avoid service overload, filter expressions must not exceed 100 characters of text and their execution on the result must not exceed 100 ms execution time.","required":false,"schema":{"type":"string","default":""}},{"name":"geom","in":"query","description":"local, full or none. Specifies the geometry representation in the result. Default = local. Local geometry is used for map display purposes, returning geometry pieces that cover the given search radius, bounding box or corridor polygon. Full geometry is used for interactive editing, where the original geometry is required. None is used for applications like geofencing, which most of the time want to know only the ids of the geofence points/lines polygons they are in or near.","required":false,"schema":{"type":"string","enum":["local","full","none"],"default":"local"}},{"name":"storage","in":"query","description":"Optional, default searches in both. Specify 'updatable' or 'readonly', how you uploaded the layer.","required":false,"schema":{"type":"string","default":"updatable"}},{"name":"map_name","in":"query","description":"Optional. Map within to look for the layer. Default: Look into the default map.","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response","required":false,"schema":{"type":"string"}},{"name":"owner_app_id","in":"query","description":"Owner app_id that was used to upload a layer.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/GeometrySearchResponse"}}}}}}},"/2/search/all.json":{"get":{"tags":["Search"],"summary":"Search for custom geometries by attribute filter, or download complete layer.","operationId":"searchAll","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"layer_id","in":"query","description":"Layer ID identifying the layers to be searched. Can also be a comma separated list of layers. Layer names are not case sensitive. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json","required":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"A JavaScript expression being evaluated for each geometry matching search query.\r\nColumns value for the geometry are available as defined variables.\r\nWhen specified, only geometries where expression evaluates to true will be returned.\r\nExample: filter=RATING > 3 && NAME != 'MyPlace23' && NAME.startsWith('Food')\r\nParameter value must be url encoded when using special characters.\r\nThis filter expression is applied after the spatial filtering, hence only to few geometries. Only for the all.json the filter is applied to all geometries, so it can become very slow for big layers. Hence, following substring search expressions use database indexes and are much faster than other filter expressions (for updatable layers):\r\nCOL_NAME.indexOf(\"my_substring\") >= 0\r\nCOL_NAME.startsWith(\"my_prefix\")\r\nCOL_NAME == \"str\"\r\nCOL_NAME === \"str\"\r\nCOL_NAME != \"str\"\r\nCOL_NAME !== \"str\"\r\nCOL_NAME.indexOf(\"str\") >= 0\r\nCOL_NAME.startsWith(\"str\")\r\nCOL_NAME.like(\"%str%\")\r\nTo avoid service overload, filter expressions must not exceed 100 characters of text and their execution on the result must not exceed 100 ms execution time.","required":false,"schema":{"type":"string","default":""}},{"name":"searchtext","in":"query","description":"Free text search with fault tolerance for custom layers and attributes. This is supported only for updatable layers if it was configured when the layer was created.","required":false,"schema":{"type":"string","default":""}},{"name":"geom","in":"query","description":"full or none. Specifies the geometry representation in the result. Default = full. Full geometry is used for interactive editing, where the original geometry is required. None is used for applications like geofencing, which most of the time want to know only the ids of the geofence points/lines polygons they are in or near.","required":false,"schema":{"type":"string","enum":["local","full","none"],"default":"full"}},{"name":"start_geometry_id","in":"query","description":"To paginate huge responses, this parameter specifies the lowest geometry id to be returned. If geometry ids are not known, then retrieve the first page using zero, and to retrieve subsequent pages then request highest geometry of current page + 1 (it doesn't matter whether this geometry id actually exists or not). Use this parameter together with no_of_records.\r\nParameter can be a single value that applies to all layers, or a comma separated list equal in number to the number of layers specified in layer_id parameter.","required":false,"schema":{"type":"string"}},{"name":"no_of_records","in":"query","description":"The number of geometries in the response. If more geometries satisfy the search/filter criteria, they will be suppressed. It is undefined, which of the matching geometries are returned, unless this parameter is used together with start_geometry_id, which sorts the results set by geometry id.\r\nParameter can be a single value that applies to all layers, or a comma separated list equal in number to the number of layers specified in layer_id parameter.\r\nThe maximum number of records supported within a single request can be looked up in the /serviceconfiguration.json endpoint.","required":false,"schema":{"type":"string"}},{"name":"map_name","in":"query","description":"Optional. Map within to look for the layer. Default: Look into the default map.","required":false,"schema":{"type":"string"}},{"name":"meta","in":"query","description":"Send with value=1 to get the response geometries framed with meta information like layer and tile id. Default = no meta data.","required":false,"schema":{"type":"string"}},{"name":"storage","in":"query","description":"Optional, default searches in both. Specify 'updatable' or 'readonly', how you uploaded the layer.","required":false,"schema":{"type":"string","default":""}},{"name":"acceptMissingLayers","in":"query","description":"Optional. If this parameter is set to true, user will get list of geometries from available layers, even if some of the requested layers are missing. If none of the requested layers are found, service returns empty list.","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"owner_app_id","in":"query","description":"Owner app_id that was used to upload the custom layer.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/GeometrySearchResponse"}}}}}}},"/2/maps/delete.json":{"get":{"tags":["Upload Data"],"summary":"Delete one of my Maps","operationId":"deleteMaps","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"map_name","in":"query","description":"name of map to delete","required":false,"schema":{"type":"string"}},{"name":"storage","in":"query","description":"Either updatable or readonly. Default = both.","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteLayersResponse"}}}}}}},"/2/layers/list.json":{"get":{"tags":["Search","Upload Data"],"summary":"List custom geometry Layers","operationId":"list","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"storage","in":"query","description":"Either updatable or readonly. Default = both.","required":false,"schema":{"type":"string"}},{"name":"map_name","in":"query","description":"show only the layers of this map, default = show the layers of all maps","required":false,"schema":{"type":"string"}},{"name":"public_maps","in":"query","description":"Optional. if '1' then the public HERE map layers are listed as well.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLayersResponse"}}}}}}},"/2/layers/delete.json":{"get":{"tags":["Upload Data"],"description":"Delete some of my Geometry Layers","operationId":"deleteLayers","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"layer_ids","in":"query","description":"Comma separated list of layers to delete","required":false,"schema":{"type":"string"}},{"name":"map_name","in":"query","description":"delete the layers within this map, default = delete the layers in app_id's default map","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteLayersResponse"}}}}}}},"/2/layers/access/grant.json":{"get":{"tags":["Upload Data"],"summary":"Grant other app_ids Access to Geometry Layers","operationId":"grantPermission","parameters":[{"name":"layer_id","in":"query","description":"name of layer for which to grant access","required":true,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"granted_app_id","in":"query","description":"Other app_id that will get access to the layer","required":true,"schema":{"type":"string"}},{"name":"permissions","in":"query","description":"Comma separated list containing read, write and/or export. read allows searches on the layer (except all.json or all.txt), write allows uploading or modifying the layer and export allows all searches. Regardless of the previous permissions, the granted_app_id replaces these access rights. An empty list revokes all permissions.","required":true,"schema":{"type":"string"}},{"name":"map_name","in":"query","description":"set the permissions for the layer in this map, default = set the permissions for the layer in app_id's default map","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LayerPermissionResponse"}}}}}}},"/2/layer/list.json":{"get":{"tags":["Search","Upload Data"],"summary":"List custom geometry Layers","operationId":"layerJSON","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"layer_id","in":"query","description":"name of layer","required":false,"schema":{"type":"string"}},{"name":"storage","in":"query","description":"Either updatable or readonly. Default = both.","required":false,"schema":{"type":"string"}},{"name":"map_name","in":"query","description":"show only the layers of this map, default = show the layers of all maps","required":false,"schema":{"type":"string"}},{"name":"public_maps","in":"query","description":"Optional. if '1' then the public HERE map layers are listed as well.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLayerAttributesResponse"}}}}}}},"/2/doc/maps.json":{"get":{"tags":["Search"],"description":"List the available custom maps","operationId":"mapsJSON","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"map_name","in":"query","description":"Optional. Restrict the search to return only the info on this map. Default: All maps of this app_id.","required":false,"schema":{"type":"string"}},{"name":"public_maps","in":"query","description":"Optional. If '1' then the public maps are also listed.","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/MapDocResponse"}}}}}}},"/2/calculaterouteisoline.json":{"get":{"tags":["Routing Extensions & Route Matching"],"summary":"Return the links within an time/distance isoline along the route","description":"The route is specified by a route_id/routeHandle, or by waypoints. See calculateroute.json for a description of the parameters.","operationId":"calculateRouteIsoline","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"route_id","in":"query","description":"Either waypoints, route_id or routeHandle is required.\r\nA routeId obtained from a previous v7.2 Router call. This routeId will be turned into an actual route.","required":false,"schema":{"type":"string"}},{"name":"routeHandle","in":"query","description":"Either waypoints, route_id or routeHandle is required.\r\nA routeHandle obtained from a previous v8 Router call. This routeHandle will be turned into an actual route.","required":false,"schema":{"type":"string"}},{"name":"max_detour_distance","in":"query","description":"Maximum driving distance in meters from the route path. This is one way, from the junction that leaves the route until to the map object. The distance to get back onto the route is not considered here. Either distance or time limit must be specified.","required":false,"schema":{"type":"number","format":"double"}},{"name":"max_detour_time","in":"query","description":"Maximum driving time in seconds from the route path. This is one way, from the junction that leaves the route until to the map object. The time to get back onto the route is not considered here. Either distance or time limit must be specified.","required":false,"schema":{"type":"number","format":"double"}},{"name":"geom","in":"query","required":false,"schema":{"type":"string","enum":["local","full","none"],"default":"local"}},{"name":"region","in":"query","description":"Optional (default=whole world excl. JPN, CHN, SK). Map coverage region, e.g. APAC, AUS, WEU, IND, MEA, NA, SAM, TWN, JPN. The region may contain hints to distinguish specific content. E.g. there can be an WEU and PCBEU, where the 2nd map contains only Postal Code Boundary layers. If not specified, the service will find the region(s) automatically, that cover the request. The parameter can contain a comma separated list of regions (f.e. WEU,MEA). If the region parameter is specified, the service will use these region(s) and skip region(s) that may also cover the response (f.e. EEU). Except of JPN, specifying a region is strongly discouraged, because regions might change and hence applications that specify a region might stop working when the region gets discontinued, renamed, split or changed otherwise. As the APAC region contains a simplified entry map content of JPN, JPN needs to be specified as region to access the full JPN content.","required":false,"schema":{"type":"string"}},{"name":"language","in":"query","required":false,"schema":{"type":"string"}},{"name":"departure","in":"query","required":false,"schema":{"type":"string"}},{"name":"trailerType","in":"query","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","required":false,"schema":{"type":"string"}},{"name":"minimalPollution","in":"query","required":false,"schema":{"type":"string"}},{"name":"hov","in":"query","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"The routing mode (e.g. fastest;car;traffic:disabled) that determines how the route is calculated. When route_id/routeHandle is used for the corridor search then please specify the same mode which was used to get the route id or route handle.","required":false,"schema":{"type":"string"}},{"name":"transportMode","in":"query","description":"Mode of transport to be used for the calculation of the route: car, truck, pedestrian;It determines how the route is calculated. When routeHandle is used for the corridor search then please specify the same transportMode which was used to get the route handle.","required":false,"schema":{"type":"string"}},{"name":"routingMode","in":"query","description":"Specifies which optimization is applied during route calculation: fast, short;It determines how the route is calculated. When routeHandle is used for the corridor search then please specify the same routingMode which was used to get the route handle.","required":false,"schema":{"type":"string"}},{"name":"searchInterval","in":"query","description":"Specifies in which intervals route isoline POIs are requested. Defined as from/to elapsed time on the route &searchInterval=fromSeconds,ToSeconds,FromSeconds,ToSeconds,...","required":false,"schema":{"type":"string"}},{"name":"mapMatchRadius","in":"query","description":"Maximum adaptive map match search radius [meter]. Will be applied to each way point. If given it overrides waypoints' transitRadius values and the default maximum adaptive search radius. For routing, default 1600. Limit 5000.","required":false,"schema":{"type":"string"}},{"name":"linkAttributes","in":"query","description":"Define optional attributes to be returned for each link. Defaults to shape, length, remainTime, remainDistance, flags. Also supported: cost","required":false,"schema":{"type":"string"}},{"name":"responseAttributes","in":"query","description":"Defines which information is included in the response as part of the calculated route isoline. Defaults to warnings (wn). Can be excluded in the response by putting a hyphen in the front. e.g. -wn","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/GeometrySearchResponse"}}}}}}},"/2/calculateisoline.json":{"get":{"tags":["Routing Extensions & Route Matching"],"description":"Return polygon or links that can be reached from a given start (or to a given destination) within a given amount of driving time, distance or cost.","operationId":"calculateIsoline","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start location. Provided as latitude, longitude in WGS-84 degree separated by a comma. Either start or destination must be specified","required":false,"schema":{"type":"string"}},{"name":"destination","in":"query","description":"Destination location. Provided as latitude, longitude in WGS-84 degree separated by a comma. Either start or destination must be specified","required":false,"schema":{"type":"string"}},{"name":"rangeType","in":"query","description":"time, distance or consumption","required":false,"schema":{"type":"string"}},{"name":"range","in":"query","description":"Comma separated list of ranges. For time: seconds, for distance: meters, for consumption: cost (in either specified currency unit or in the same unit like the consumptiondetails or driver/vehicle cost). Up to 10 isolines are supported.","required":false,"schema":{"type":"string"}},{"name":"departure","in":"query","description":"Format: now, yyyy-MM-dd'T'HH:mm:ss or yyyy-MM-dd'T'HH:mm:ssX. Default: Ignore all time dependent access restrictions. If no timezone is specified, then the local timezone at the route start link is used.","required":false,"schema":{"type":"string"}},{"name":"arrival","in":"query","description":"Format: Like departure. Use for reverse isoline (destination specified)","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"fastest;car[;traffic:disabled][;optional parameters...] Traffic can be disabled or enabled (real time + traffic pattern usage), default disabled. As optional parameters motorway (0, -1, -2, -3) and tollroad (0, -1, -2, -3) can follow. See chapter 'Vehicle Types and Measures' for supported vehicle types.","required":false,"schema":{"type":"string"}},{"name":"customConsumptionDetails","in":"query","description":"Semicolon separated list of speed/ascent/descent/builtupFactor fuel consumption parameters. Speed is a list of $/km for different speeds. Ascent/descent are additional $/km per altitude climbed or descended. Builtup factor is an optional heuristic consumption multiplier for urban area, default value is 1.55. Cost unit is not $ but 'currency'. Example: speed,0,0.102,10,0.084,30,0.066,50,0.06,70,0.066,100,0.072,120,0.084,140,0.108; ascent,0.4; descent,0.1; builtupFactor,1.4 = at 70 kph the car consumes 6$/100km and 0.4$/km altitude climbed, consumption increases 40% in urban area. Alternatively, user can specify default consumption profile: 3.5t, 7.5t, 18t, 40t or weightDependent. In case of the weightDependent consumption profiles will be decided based on the limitedWeight so this parameter also needs to be specified.","required":false,"schema":{"type":"string"}},{"name":"isolineAttributes","in":"query","description":"links or shape or links,shape","required":false,"schema":{"type":"string","default":"shape"}},{"name":"trailerType","in":"query","description":"0=None, 1=Caravan, 2=Trailer, 3=RVTrailer, 4=BoatTrailer. For toll cost and recreational vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailersCount","in":"query","description":"Number of trailers, 0...4. For toll cost and truck restrictions. 0=no trailer, 1=one or more trailers, 2=two or more trailers, 3=three or more trailers. For truck restrictions: 4=one or more semi-trailers.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"vehicleNumberAxles","in":"query","description":"Number of axles excluding trailers. For toll cost and for country wide truck restrictions.
","required":false,"schema":{"type":"string"}},{"name":"trailerNumberAxles","in":"query","description":"Number of trailer axles. For toll cost and for country wide truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"hybrid","in":"query","description":"1=fuel+electric, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"emissionType","in":"query","description":"1=EURO I, 2=EURO II, 3=EURO III, 4=EURO IV, 5=EURO V, 6=EURO VI, 7=EURO EEV, 8=Electric Vehicles, 9=EURO II with PRC, 10=EURO III with PRC. For toll cost and environmental zone restrictions, when emissionType is not specified it defaults to 5.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"co2EmissionClass","in":"query","description":"CO2 emission class of the vehicle. 1=Emission class 1, 2=Emission class 2, 3=Emission class 3, 4=Emission class 4, 5=Emission class 5. For toll cost only, when co2EmissionClass is not specified then it defaults to 1. Providing invalid combination of emissionType and co2EmissionClass in request may result in incorrect toll costs.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"height","in":"query","description":"Actual height of the overall rigid/semi truck including trailers: 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"trailerHeight","in":"query","description":"Actual height of the trailer(s). 350cm or 3.5m or 138in. For toll cost only, not considered for route path creation (use height parameter)
(Not available for Waypoints Sequence).","required":false,"schema":{"type":"string"}},{"name":"vehicleWeight","in":"query","description":"Actual total weight of vehicle incl. payload, but not trailers' weight or payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"limitedWeight","in":"query","description":"Actual total weight of vehicle incl. payload and trailers/caravan incl. their payload. 7.5t or 7500kg or 16500lbs. For truck restrictions, speed profile, toll cost and environmental zone restrictions. See also vehicleWeight. Note that country wide weight restrictions depend on the number of axles and trailers as well, so it might be necessary to specify them as well.","required":false,"schema":{"type":"string"}},{"name":"vehicleWeightClass","in":"query","description":"Legal maximum weight limit of vehicle incl. payload and trailers. Also incl. their payload as a total. 7.5t or 7500kg or 16500lbs. For truck restrictions.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"disabledEquipped","in":"query","description":"1=vehicle equipped to carry disabled people, 0=otherwise. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"passengersCount","in":"query","description":"Actual number of passengers. For toll cost. See also vehicle type carHOV.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"tiresCount","in":"query","description":"Number of tires. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"commercial","in":"query","description":"1=vehicle registered for commercial use, 0=otherwise. For toll cost, environmental zone regulations and delivery-only zones.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"shippedHazardousGoods","in":"query","description":"Comma separated list from explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable. For toll cost (only explosive and other) and for truck restrictions. For Waypoints Sequence, allhazardousGoods and explosiveFlammable are not supported.","required":false,"schema":{"type":"string"}},{"name":"heightAbove1stAxle","in":"query","description":"350cm or 3.5m or 138in. For toll cost.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","description":"Length of the vehicle (including potential trailers). 350cm or 3.5m or 138in. For truck restrictions and toll cost.","required":false,"schema":{"type":"string"}},{"name":"weightPerAxle","in":"query","description":"Actual total weight per axle, incl. payload. 7.5t or 7500kg or 16500lbs (Waypoints Sequence in kg, no unit). For toll cost and truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"width","in":"query","description":"Width of the vehicle, e.g. 350cm or 3.5m or 138in. For truck restrictions.","required":false,"schema":{"type":"string"}},{"name":"tunnelCategory","in":"query","description":"Defines the tunnel categories the truck must NOT use. B, C, D or E. A tunnels have no restrictions. E tunnels have most restrictions. If C is defined, the route will use A and B tunnels but not C, D or E.","required":false,"schema":{"type":"string"}},{"name":"fuelType","in":"query","description":"Defines the fuel powering the vehicle. Can be Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric. (LPG=Liquefied Petroleum Gas, LNG=Liquefied Natural Gas). Used f.e. for environmental zone restrictions, toll cost calculation, consumption based routing for Electric vehicles.
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"weightPerAxleGroup","in":"query","description":"Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported names are drive, single, tandem, triple, quad, quint. Example: &weightPerAxleGroup=drive:12;single:11;tandem:18
(Not available for Waypoints Sequence)","required":false,"schema":{"type":"string"}},{"name":"trailerWeight","in":"query","description":"Actual total weight of trailers with their payload. 7.5t or 7500kg or 16500lbs. See also limitedWeight. For toll cost.","required":false,"schema":{"type":"string"}},{"name":"overlays","in":"query","description":"Overlay map name. Case insensitive. Must start with OVERLAY and contain only characters.","required":false,"schema":{"type":"string"}},{"name":"speedFcCat","in":"query","description":"Comma separated list of speeds driven in kilometer per hour per road functional class (1-5 + Virtual Connections VC) and speed category (1-8) (f.e. FC1-SC1,FC1-SC2,...,FC1-SC8;FC2-SC1,FC2-SC2,...;...;VC-SC1,FC-SC2,...VC-SC8). Functional classes are semicolon separated. Can contain empty entries (no change to default f.e. 80,76,,,,,,;,,,54,46,,,;...). Overrides router's default driven speed values.","required":false,"schema":{"type":"string"}},{"name":"region","in":"query","description":"Optional (default=whole world excl. JPN, CHN, SK). Map coverage region, e.g. APAC, AUS, WEU, IND, MEA, NA, SAM, TWN, JPN. The region may contain hints to distinguish specific content. E.g. there can be an WEU and PCBEU, where the 2nd map contains only Postal Code Boundary layers. If not specified, the service will find the region(s) automatically, that cover the request. The parameter can contain a comma separated list of regions (f.e. WEU,MEA). If the region parameter is specified, the service will use these region(s) and skip region(s) that may also cover the response (f.e. EEU). Except of JPN, specifying a region is strongly discouraged, because regions might change and hence applications that specify a region might stop working when the region gets discontinued, renamed, split or changed otherwise. As the APAC region contains a simplified entry map content of JPN, JPN needs to be specified as region to access the full JPN content.","required":false,"schema":{"type":"string"}},{"name":"mapMatchRadius","in":"query","description":"Maximum adaptive map match search radius [meter]. Will be applied to each way point. If given it overrides waypoints' transitRadius values and the default maximum adaptive search radius. For routing, default 1600. Limit 5000.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/IsolineResponse"}}}}}}},"/1/tiles.json":{"get":{"tags":["Map Attributes","Search"],"summary":"Multiple tiles' rows from layer(s)","description":"Retrieve the rows from within given tile(s) out of one or more layers. Does not work for custom layers.","operationId":"tilesJSON","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"layers","in":"query","description":"Thematic Layer names, one per requested tile, comma separated list.","required":false,"schema":{"type":"string"}},{"name":"region","in":"query","description":"Optional (default=whole world excl. JPN, CHN, SK). Map coverage region, e.g. APAC, AUS, WEU, IND, MEA, NA, SAM, TWN, JPN. The region may contain hints to distinguish specific content. E.g. there can be an WEU and PCBEU, where the 2nd map contains only Postal Code Boundary layers. If not specified, the service will find the region(s) automatically, that cover the request. The parameter can contain a comma separated list of regions (f.e. WEU,MEA). If the region parameter is specified, the service will use these region(s) and skip region(s) that may also cover the response (f.e. EEU). Except of JPN, specifying a region is strongly discouraged, because regions might change and hence applications that specify a region might stop working when the region gets discontinued, renamed, split or changed otherwise. As the APAC region contains a simplified entry map content of JPN, JPN needs to be specified as region to access the full JPN content.","required":false,"schema":{"type":"string"}},{"name":"release","in":"query","description":"Map release quarter, e.g. 2015Q4, 161J0, 16153 or LATEST (= default) for the latest available map release quarter. Specifying a map release is strongly discouraged, because there is no guarantee how long old map releases are available, hence applications that specify a release might stop working when the release gets retired. To choose a (nearest to) specific snapshot of the live traffic speed record or archived weather layer, a UNIX timestamp (number of milliseconds since 1970) or a date in 2017-12-01T17:30:00+01:00 format can be passed.","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"levels","in":"query","description":"Level of each requested layer, as specified in the layers' documentation, comma separated list.","required":false,"schema":{"type":"string"}},{"name":"tilexy","in":"query","description":"Comma separated sequence of tilex,tiley pairs for the requested tiles. The tilex and tiley values are described in the tile.json resource.","required":false,"schema":{"type":"string"}},{"name":"meta","in":"query","description":"Optional. If '1' then each response tile is framed with meta information (layer, level, tilex, tiley, region, release).","required":false,"schema":{"type":"string"}},{"name":"cols","in":"query","description":"Optional. Selects the subset of attributes in the response. Semicolon separated list of attributes, within a per-tile comma separated list. Example: cols=LAT;LON,LAT will retain only LAT and LON in first tile's result rows and retain only LAT in second tile's result.","required":false,"schema":{"type":"string"}},{"name":"link2stabletopologyid","in":"query","description":"Optional. If '1' then the result records have 2 additional columns: TOPOLOGY_ID and START_OFFSET. The HERE topology segment PVID identifies a stretch of roads between 2 intersections. Links are subsets of a topology segment, hence the offset attributes define the range of the link within the topology segment [0..1].","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TileResponse"}}}}}}}},"/1/tile.json":{"get":{"tags":["Map Attributes","Search"],"summary":"Tile of rows from a layer","description":"Retrieve the rows from within a given tile of this layer. Does not work for custom layers.","operationId":"tileJson","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"layer","in":"query","description":"Thematic layer name","required":true,"schema":{"type":"string"}},{"name":"region","in":"query","description":"Optional (default=whole world excl. JPN, CHN, SK). Map coverage region, e.g. APAC, AUS, WEU, IND, MEA, NA, SAM, TWN, JPN. The region may contain hints to distinguish specific content. E.g. there can be an WEU and PCBEU, where the 2nd map contains only Postal Code Boundary layers. If not specified, the service will find the region(s) automatically, that cover the request. The parameter can contain a comma separated list of regions (f.e. WEU,MEA). If the region parameter is specified, the service will use these region(s) and skip region(s) that may also cover the response (f.e. EEU). Except of JPN, specifying a region is strongly discouraged, because regions might change and hence applications that specify a region might stop working when the region gets discontinued, renamed, split or changed otherwise. As the APAC region contains a simplified entry map content of JPN, JPN needs to be specified as region to access the full JPN content.","required":false,"schema":{"type":"string"}},{"name":"release","in":"query","description":"Map release quarter, e.g. 2015Q4, 161J0, 16153 or LATEST (= default) for the latest available map release quarter. Specifying a map release is strongly discouraged, because there is no guarantee how long old map releases are available, hence applications that specify a release might stop working when the release gets retired. To choose a (nearest to) specific snapshot of the live traffic speed record or archived weather layer, a UNIX timestamp (number of milliseconds since 1970) or a date in 2017-12-01T17:30:00+01:00 format can be passed.","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"level","in":"query","description":"Level of the requested layer, as specified in layer's documentation.","required":false,"schema":{"type":"string"}},{"name":"tilex","in":"query","description":"Tile number in West-East direction. Depends on the level. The tile covering the longitude LON [WGS84 degree] has tileX = floor((LON + 180.0) / tileSize), where tileSize = 180 / 2^level. The tile with a given tileX value covers the longitude range [ tileX * tileSize - 180.0 ... (tileX + 1) * tileSize - 180.0 ].","required":false,"schema":{"type":"string"}},{"name":"tiley","in":"query","description":"Tile number in South-North direction. Depends on the level. The tile covering the latitude LAT [WGS84 degree] has tileY = floor((LAT + 90.0) / tileSize), where tileSize = 180 / (2^level). The tile with a given tileY value covers the latitude range [ tileY * tileSize - 90.0 ... (tileY + 1) * tileSize - 90.0 [.","required":false,"schema":{"type":"string"}},{"name":"meta","in":"query","description":"Optional. If '1' then each response tile is framed with meta information (layer, level, tilex, tiley, region, release).","required":false,"schema":{"type":"string"}},{"name":"cols","in":"query","description":"Optional. Selects the subset of attributes in the response. Semicolon separated list of attributes, within a per-tile comma separated list. Example: cols=LAT;LON,LAT will retain only LAT and LON in first tile's result rows and retain only LAT in second tile's result.","required":false,"schema":{"type":"string"}},{"name":"link2stabletopologyid","in":"query","description":"Optional. If '1' then the result records have 2 additional columns: TOPOLOGY_ID and START_OFFSET. The HERE topology segment PVID identifies a stretch of roads between 2 intersections. Links are subsets of a topology segment, hence the offset attributes define the range of the link within the topology segment [0..1].","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/TileResponse"}}}}}}},"/1/static.json":{"get":{"tags":["Map Attributes","Search"],"summary":"Static layer's content","description":"Retrieve the rows from the static layer's content. Does not include custom layers.","operationId":"staticJSON","parameters":[{"name":"content","in":"query","description":"Static content layer name","required":true,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"link2stabletopologyid","in":"query","description":"Optional. If '1' then the result records have 2 additional columns: TOPOLOGY_ID and START_OFFSET. The HERE topology segment PVID identifies a stretch of roads between 2 intersections. Links are subsets of a topology segment, hence the offset attributes define the range of the link within the topology segment [0..1].","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/TileResponse"}}}}}}},"/1/serviceconfiguration.json":{"get":{"tags":["Map Attributes","Search"],"summary":"Service parameter boundary values","description":"Numeric constants and limits for the service calls. Will never become more strict, but can become more relaxed in future releases.","operationId":"getServiceConfiguration_6","parameters":[{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceConfigurationResponse"}}}}}}},"/1/search/quadkey.json":{"get":{"tags":["Map Attributes","Search"],"summary":"Retrieve layer content within a quadkey","description":"Retrieve the layer content records within a given geo rectangle specified by a (standard WGS84 Mercator) quadkey. Does not work for custom layers.","operationId":"searchQuadKey_1","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"layer_id","in":"query","description":"Layer name to be searched. Layer name is not case sensitive. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json","required":true,"schema":{"type":"string"}},{"name":"key_attribute","in":"query","description":"the key column(s) of this layer, as defined in the layer specification","required":false,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"List of comma separated column names to specify which attributes shall appear in the result. Column names are not case sensitive. Default = all.","required":false,"schema":{"type":"string"}},{"name":"quad_key","in":"query","description":"The quad key number of the map tile area to search from.","required":true,"schema":{"type":"string"}},{"name":"geom","in":"query","description":"local, full or none. Specifies the geometry representation in the result. Default = local. Local geometry is used for map display purposes, returning geometry pieces that cover the given search radius, bounding box or corridor polygon. Full geometry is used for interactive editing, where the original geometry is required. None is used for applications like geofencing, which most of the time want to know only the ids of the geofence points/lines polygons they are in or near.","required":false,"schema":{"type":"string","default":"local"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"region","in":"query","description":"Optional (default=whole world excl. JPN, CHN, SK). Map coverage region, e.g. APAC, AUS, WEU, IND, MEA, NA, SAM, TWN, JPN. The region may contain hints to distinguish specific content. E.g. there can be an WEU and PCBEU, where the 2nd map contains only Postal Code Boundary layers. If not specified, the service will find the region(s) automatically, that cover the request. The parameter can contain a comma separated list of regions (f.e. WEU,MEA). If the region parameter is specified, the service will use these region(s) and skip region(s) that may also cover the response (f.e. EEU). Except of JPN, specifying a region is strongly discouraged, because regions might change and hence applications that specify a region might stop working when the region gets discontinued, renamed, split or changed otherwise. As the APAC region contains a simplified entry map content of JPN, JPN needs to be specified as region to access the full JPN content.","required":false,"schema":{"type":"string"}},{"name":"release","in":"query","description":"Map release quarter, e.g. 2015Q4, 161J0, 16153 or LATEST (= default) for the latest available map release quarter. Specifying a map release is strongly discouraged, because there is no guarantee how long old map releases are available, hence applications that specify a release might stop working when the release gets retired. To choose a specific snapshot of the live traffic speed record or archived weather layer, a UNIX timestamp (number of milliseconds since 1970) or a date in 2017-12-01T17:30:00+01:00 format can be passed.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/GeometrySearchResponse"}}}}}}},"/1/search/bbox.json":{"get":{"tags":["Map Attributes","Search"],"summary":"Retrieve layer content within given geo rectangle","description":"Retrieve the layer content records within given geo bounding box. Does not work for custom layers.","operationId":"searchBbox","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"layer_id","in":"query","description":"Layer name to be searched. Layer name is not case sensitive. The maximum length of a layer name and the permitted characters can be looked up up in the service via /serviceconfiguration.json","required":true,"schema":{"type":"string"}},{"name":"key_attribute","in":"query","description":"the key column(s) of this layer, as defined in the layer specification","required":false,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"List of comma separated column names to specify which attributes shall appear in the result. Column names are not case sensitive. Default = all.","required":false,"schema":{"type":"string"}},{"name":"bbox","in":"query","description":"A bounding box, provided as upper, left, lower and right coordinates in WGS84 degrees. All geometries overlapping this rectangle will be returned.\r\nThe format is north latitude,west longitude;south latitude,east longitude.\r\nExample: bbox=37.8,-122.1;37.2,-122.0","required":true,"schema":{"type":"string"}},{"name":"geom","in":"query","description":"local, full or none. Specifies the geometry representation in the result. Default = local. Local geometry is used for map display purposes, returning geometry pieces that cover the given search radius, bounding box or corridor polygon. Full geometry is used for interactive editing, where the original geometry is required. None is used for applications like geofencing, which most of the time want to know only the ids of the geofence points/lines polygons they are in or near.","required":false,"schema":{"type":"string","default":"local"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"region","in":"query","description":"Optional (default=whole world excl. JPN, CHN, SK). Map coverage region, e.g. APAC, AUS, WEU, IND, MEA, NA, SAM, TWN, JPN. The region may contain hints to distinguish specific content. E.g. there can be an WEU and PCBEU, where the 2nd map contains only Postal Code Boundary layers. If not specified, the service will find the region(s) automatically, that cover the request. The parameter can contain a comma separated list of regions (f.e. WEU,MEA). If the region parameter is specified, the service will use these region(s) and skip region(s) that may also cover the response (f.e. EEU). Except of JPN, specifying a region is strongly discouraged, because regions might change and hence applications that specify a region might stop working when the region gets discontinued, renamed, split or changed otherwise. As the APAC region contains a simplified entry map content of JPN, JPN needs to be specified as region to access the full JPN content.","required":false,"schema":{"type":"string"}},{"name":"release","in":"query","description":"Map release quarter, e.g. 2015Q4, 161J0, 16153 or LATEST (= default) for the latest available map release quarter. Specifying a map release is strongly discouraged, because there is no guarantee how long old map releases are available, hence applications that specify a release might stop working when the release gets retired. To choose a specific snapshot of the live traffic speed record or archived weather layer, a UNIX timestamp (number of milliseconds since 1970) or a date in 2017-12-01T17:30:00+01:00 format can be passed.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/GeometrySearchResponse"}}}}}}},"/1/index.json":{"get":{"tags":["Map Attributes","Search"],"summary":"Tile IDs containing a given value","description":"Retrieve the IDs of tiles that contain a given (set of) attribute value(s). Does not work for custom layers.","operationId":"indexJSON","parameters":[{"name":"layer","in":"query","description":"layer name","required":true,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"attributes","in":"query","description":"comma separated list of index attribute names","required":false,"schema":{"type":"string"}},{"name":"values","in":"query","description":"comma separated list of index attribute values, corresponding to the attribute names","required":false,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/IndexResponse"}}}}}}},"/1/file.bin":{"get":{"tags":["Map Attributes","Search"],"summary":"File content","description":"Retrieve the binary content of a file, like a junction view image","operationId":"getFile","parameters":[{"name":"layer","in":"query","description":"layer name","required":false,"schema":{"type":"string"}},{"name":"path","in":"query","description":"file path, as specified in the referencing layer's attribute value","required":false,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"type":"string"}}}}}}},"/1/doc/scontents.json":{"get":{"tags":["Map Attributes","Search"],"summary":"List static content layers","description":"List the available static content (non-tiled) layers. Does not list custom layers.","operationId":"staticContentsJSON","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StaticContentDocBean"}}}}}}}},"/1/doc/scontent.json":{"get":{"tags":["Map Attributes","Search"],"summary":"List static layer's attributes","description":"List the attributes of a given static (non tiled) layer. Does not work for custom layers.","operationId":"staticContentJSON","parameters":[{"name":"content","in":"query","description":"Static content layer name","required":false,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/StaticContentDetailDocBean"}}}}}}},"/1/doc/maps.json":{"get":{"tags":["Map Attributes","Search"],"summary":"List available map regions/releases","description":"List available map regions/releases. Does not list custom maps.","operationId":"mapsJSON_1","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/MapDocResponse"}}}}}}},"/1/doc/layers.json":{"get":{"tags":["Map Attributes","Search"],"summary":"List the available map layers","description":"List available map layers. To see only the layers of a given map region, like Postal Code Boundaries, then specify it as map 'region'. Does not list the custom layers.","operationId":"layersJSON","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LayerDocBean"}}}}}}}},"/1/doc/layer.json":{"get":{"tags":["Map Attributes","Search"],"summary":"List the layer attributes","description":"List the attributes of a given layer. Does not list the custom layers.","operationId":"layerJSON_1","parameters":[{"name":"layer","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/LayerDetailDocBean"}}}}}}},"/1/doc/indexes.json":{"get":{"tags":["Map Attributes","Search"],"summary":"List available layer indexes","description":"List the available indexes of all available layers. Does not list indexes of custom layers.","operationId":"indexesJSON","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response.","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IndexDocBean"}}}}}}}},"/1/doc/attributes.json":{"get":{"tags":["Map Attributes","Search"],"summary":"List the layer attributes across all layers","description":"List the map layer attributes across all layers. Does not list the custom layers.","operationId":"attributesJSON","parameters":[{"name":"app_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"app_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"callback","in":"query","description":"Specifies the function used to wrap the JSON response","required":false,"schema":{"type":"string"}},{"name":"requestBody","in":"query","required":true,"schema":{"type":"object","properties":{"short":{"type":"integer","format":"int32"},"char":{"type":"string"},"int":{"type":"integer","format":"int32"},"long":{"type":"integer","format":"int64"},"float":{"type":"number","format":"float"},"double":{"type":"number","format":"double"},"direct":{"type":"boolean"},"readOnly":{"type":"boolean"}}}},{"name":"apikey","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json;charset=UTF-8":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AttributeDocBean"}}}}}}}}},"components":{"schemas":{"OverlaySubmitResponse":{"type":"object","properties":{"warnings":{"type":"array","items":{"type":"string"}},"layers":{"type":"array","description":"Names of map layers generated from the overlay submission","items":{"type":"string","description":"Names of map layers generated from the overlay submission"}},"meta":{"type":"array","items":{"$ref":"#/components/schemas/SearchMetaResponse"}}}},"SearchMetaResponse":{"type":"object","properties":{"search":{"type":"string","description":"the search id in the request where these result geometries belong to"},"searchParameter":{"type":"string","writeOnly":true},"layerId":{"type":"string","description":"the layername the geometry belongs to"},"lastUpdateTimeStamp":{"type":"integer","description":"last modification milli second timestamp","format":"int64"}}},"BaseResponse":{"type":"object"},"BoundingBox":{"type":"object","properties":{"topLeft":{"$ref":"#/components/schemas/Coordinate"},"bottomRight":{"$ref":"#/components/schemas/Coordinate"}}},"Coordinate":{"type":"object","properties":{"latitude":{"type":"number","format":"double","example":48.33294},"longitude":{"type":"number","format":"double","example":8.13556}},"description":"from request"},"CostDetails":{"type":"object","properties":{"driverCost":{"type":"string","description":"computed from request's driver_cost value and the travel time (with or without ferry time)","example":"430.8"},"vehicleCost":{"type":"string","description":"computed from request's vehicle_cost value and the travel distance (with or without ferry travel)","example":"330.0"},"tollCost":{"type":"string","description":"total toll fee","example":"130.1"},"optionalValue":{"type":"string","description":"value earned by picking + dropping optional waypoints"},"energyCost":{"type":"string","description":"computed based on request's consumptiondetails","example":"233.75"},"totalCost":{"type":"number","format":"double","example":500.55}}},"Costs":{"type":"object","properties":{"totalCost":{"type":"string","description":"sum of all cost elements","example":"1335.7"},"currency":{"type":"string","description":"currency unit of the costs","example":"EUR"},"details":{"$ref":"#/components/schemas/CostDetails"}}},"CurrencyAmount":{"type":"object","properties":{"country":{"type":"string","description":"country is the three letter ISO 3166 country code."},"adminId":{"type":"string","description":"adminId is the country's admin place id.","example":"DEU"},"tollSystemId":{"type":"string","description":"tollSystemId is the unique toll system identifier."},"name":{"type":"string","description":"Toll system name"},"languageCode":{"type":"string","description":"Language code of toll system name"},"amountInTargetCurrency":{"type":"number","format":"double"}},"description":"totalCost is the sum of all cost elements."},"KeyValue":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"object"}},"description":"requested PDE layer attributes for the link"},"Leg":{"type":"object","properties":{"length":{"type":"integer","format":"int32"},"travelTime":{"type":"integer","description":"travel time [sec] without considering traffic impact (use only if mode=traffic:disabled)","format":"int32","example":3800},"link":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"maneuver":{"type":"array","items":{"$ref":"#/components/schemas/Maneuver"}},"shape":{"type":"array","items":{"type":"number","format":"double"}},"boundingBox":{"$ref":"#/components/schemas/BoundingBox"},"trafficTime":{"type":"integer","description":"travel time [sec] considering traffic impact (use only if mode=traffic:enabled)","format":"int32"},"baseTime":{"type":"integer","description":"travel time [sec] without considering traffic impact (use only if mode=traffic:disabled)","format":"int32"},"refReplacements":{"type":"object","additionalProperties":{"type":"string"}},"legShape":{"type":"array","writeOnly":true,"items":{"type":"number","format":"double"}},"firstPoint":{"type":"integer","description":"Index into the global geometry array, pointing to the first point of the shape subsegment associated with this Maneuver. Must be followed by LastPoint.","format":"int32","example":0},"lastPoint":{"type":"integer","description":"Index into the global geometry array, pointing to the last point of the shape subsegment associated with this Maneuver. Must be preceded by FirstPoint.","format":"int32"},"turnByTurnManeuver":{"type":"array","items":{"$ref":"#/components/schemas/TurnByTurnManeuver"}},"stayingTime":{"type":"integer","description":"Indicates time spent on recharging(in seconds). Only available if the maneuver has a chargingStopOver.","format":"int32"},"arrivalBatteryCharge":{"type":"number","description":"Indicates battery energy when reaching the recharge waypoint. Only available if the maneuver has a chargingStopOver.","format":"double","example":8.56},"targetBatteryCharge":{"type":"number","description":"Indicates battery energy after charging when leaving the recharge waypoint. Only available if the maneuver has a chargingStopOver.","format":"double"}},"description":"one leg traverses between two mandatory stopover waypoints"},"Link":{"type":"object","properties":{"linkId":{"type":"string","description":"Permanent version id (HERE core map), negative sign means driven towards reference node"},"length":{"type":"number","description":"Returns the link length in meter (to match HLS router response) or in centimeter - depending on the setting passed in the constructor.","format":"double"},"remainDistance":{"type":"number","description":"meters left when entering this link, for the entire route (not just in between legs)","format":"double"},"remainTime":{"type":"number","description":"Seconds left when entering this link, for the entire route (not just in between legs). Millisecond precision if link attributes PRECISETIMEDISTANCE requested.","format":"double"},"shape":{"type":"array","description":"List of WGS84 degree latitude/longitude coordinates in driving direction sequence order","items":{"type":"number","description":"List of WGS84 degree latitude/longitude coordinates in driving direction sequence order","format":"double"}},"functionalClass":{"type":"integer","description":"Functional Class defines a hierarchical network used to determine a logical and efficient route.","format":"int32"},"confidence":{"type":"number","description":"0...1 link match confidence (only for route match mode)","format":"double"},"attributes":{"type":"object","additionalProperties":{"type":"array","description":"requested PDE layer attributes for the link","items":{"type":"array","description":"requested PDE layer attributes for the link","items":{"$ref":"#/components/schemas/KeyValue"}}},"description":"requested PDE layer attributes for the link"},"cost":{"$ref":"#/components/schemas/CostDetails"},"remainingDistanceToDestinationCentimeter":{"type":"integer","format":"int64","writeOnly":true},"warning":{"type":"array","items":{"$ref":"#/components/schemas/ResponseIssue"}},"consumption":{"type":"number","description":"energy consumption to traverse the link, in target currency","format":"double"},"timezone":{"type":"integer","description":"Timezone offset to UTC in minutes when the time zone of the link changes compared to previous link","format":"int32"},"segmentRef":{"type":"string","description":" : : # <+-> OffsetFrom .. OffsetTo where the +- indicates whether the segment is driven algined with the order of its coordinates"}}},"Maneuver":{"type":"object","properties":{"position":{"$ref":"#/components/schemas/ManeuverPosition"},"instruction":{"type":"string","description":"tagged driver instruction text in the requested language","example":"Head West on M1 / Pacific Mtwy. Go for 56 m."},"instructionBefore":{"type":"string"},"instructionAfter":{"type":"string","example":"After 56 m, take the exit onto 24"},"travelTime":{"type":"integer","description":"Time [sec] to drive until to this maneuver point","format":"int32","example":150},"length":{"type":"integer","description":"Distance [meter] to drive until to this maneuver point","format":"int32"},"id":{"type":"string"},"direction":{"type":"string","description":"Indicates whether directions should be included in the maneuvers. Supported directions are: forward, lightRight, right, hardRight, uTurnRight, lightLeft, left, hardLeft, uTurnLeft."},"action":{"type":"string","description":"Indicates whether actions should be included in the maneuvers. Supported actions are: depart, arrive, slightLeftTurn, leftTurn, sharpLeftTurn, leftUTurn , continue, slightRightTurn, rightTurn, sharpRightTurn, rightUTurn, RoundaboutExit, exit, uTurn, turn, keep.","example":"leftTurn"},"firstPoint":{"type":"integer","description":"Index into the global geometry array, pointing to the first point of the shape subsegment associated with this Maneuver. Must be followed by LastPoint.","format":"int32","example":2},"lastPoint":{"type":"integer","format":"int32"},"lanes":{"type":"string","description":"List of lane infos, viewed into driving direction, from left to right. Applicable lanes marked '*', n = not allowed for vehicle or direction, numbers denote arrows, see Map Attributes layer LANE_FCn attribute DIRECTION_CATEGORY."},"roadName":{"type":"array","items":{"$ref":"#/components/schemas/RoadName"}},"nextRoadName":{"type":"array","items":{"$ref":"#/components/schemas/RoadName"}}}},"ManeuverPosition":{"type":"object","properties":{"latitude":{"type":"number","format":"double","example":48.33294},"longitude":{"type":"number","format":"double","example":18.13294}}},"MatchedVehicleType":{"type":"object","properties":{"type":{"type":"string","description":"car, truck or pedestrian","example":"truck"},"subType":{"type":"string","description":"light, medium or heavy, applicable only for truck"},"confidence":{"type":"number","description":"confidence value of the match 0 ... 1","format":"double"}},"description":"most probable vehicle type(s), only for route match mode"},"Pass":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"annual":{"type":"boolean"},"extendedAnnual":{"type":"boolean"},"nrOfDays":{"type":"integer","format":"int32"},"nrOfMonths":{"type":"integer","format":"int32"},"seniorPass":{"type":"boolean"},"nrOfTravels":{"type":"integer","format":"int32"}}},"Response":{"type":"object","description":"Calculate route response","allOf":[{"$ref":"#/components/schemas/BaseResponse"},{"type":"object","properties":{"route":{"type":"array","description":"Route alternatives. The first route alternative has the minimum cost.","readOnly":true,"items":{"$ref":"#/components/schemas/Route"}},"language":{"type":"string","description":"Language used in maneuver instructions. 2 letter language code + 2 letter ISO country code.","readOnly":true,"example":"en-us"},"warnings":{"type":"array","description":"Warnings that are either globally for the request or apply to the first route alternative.","readOnly":true,"items":{"$ref":"#/components/schemas/ResponseIssue"}}}}]},"ResponseIssue":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"integer","format":"int32"},"truckRestrictionCategoryCode":{"type":"integer","format":"int32"},"isoCountryCode":{"type":"string"},"routeLinkSeqNum":{"type":"integer","format":"int32"},"tracePointSeqNum":{"type":"integer","format":"int32"},"wayPointSeqNum":{"type":"integer","format":"int32"},"toTracePointSeqNum":{"type":"integer","format":"int32"},"duration":{"type":"integer","format":"int64"},"plannedWayPointSeqNum":{"type":"integer","format":"int32"},"operation":{"type":"string"}},"description":"Warnings that are either globally for the request or apply to the first route alternative.","readOnly":true},"RoadName":{"type":"object","properties":{"language":{"type":"string","description":"Language used in maneuver instructions. 2 letter ISO 639-1 language code + 2 letter ISO 3166-1 alpha-2 country code."},"text":{"type":"string","example":"M1 / Pacific Mtwy"}}},"Route":{"type":"object","properties":{"mode":{"$ref":"#/components/schemas/RouteMode"},"routeFlagsInResponse":{"type":"boolean","writeOnly":true},"waypoint":{"type":"array","items":{"$ref":"#/components/schemas/WayPoint"}},"boatFerry":{"type":"boolean","description":"set if the route uses a boat ferry"},"railFerry":{"type":"boolean","description":"set if the route uses a rail ferry"},"leg":{"type":"array","description":"one leg traverses between two mandatory stopover waypoints","items":{"$ref":"#/components/schemas/Leg"}},"boundingBox":{"$ref":"#/components/schemas/BoundingBox"},"shape":{"type":"array","description":"route shape geometry points - lat, lon pairs","items":{"type":"number","description":"route shape geometry points - lat, lon pairs","format":"double"}},"summary":{"$ref":"#/components/schemas/Summary"},"cost":{"$ref":"#/components/schemas/Costs"},"matchedVehicleType":{"type":"array","description":"most probable vehicle type(s), only for route match mode","items":{"$ref":"#/components/schemas/MatchedVehicleType"}},"tollCost":{"$ref":"#/components/schemas/TCResponse"},"summaryByCountry":{"type":"array","items":{"$ref":"#/components/schemas/RouteSummaryByCountry"}}},"description":"Route alternatives. The first route alternative has the minimum cost.","readOnly":true},"RouteMode":{"type":"object","properties":{"type":{"type":"string","description":"from request: shortest, fastest or matched (route match mode)"},"transportModes":{"type":"array","description":"request's vehicle type","example":"[car]","items":{"type":"string","description":"request's vehicle type","example":"[car]"}},"trafficMode":{"type":"string","description":"from request: disabled or enabled","example":"disabled"}},"description":"from the request"},"RouteSummaryByCountry":{"type":"object","properties":{"distance":{"type":"integer","description":"travel distance [meter]","format":"int64"},"baseTime":{"type":"integer","description":"travel time [sec] without considering traffic impact (use only if mode=traffic:disabled)","format":"int64"},"trafficTime":{"type":"integer","description":"travel time [sec] considering traffic impact (use only if mode=traffic:enabled)","format":"int64"},"travelTime":{"type":"integer","description":"travel time [sec] without considering traffic impact (use only if mode=traffic:disabled)","format":"int64","example":360},"country":{"type":"string","description":"ISO 3166 country code","example":"DEU"},"tollRoadDistance":{"type":"integer","description":"toll road distance [meter]","format":"int64"}}},"RouteTollItem":{"type":"object","properties":{"linkIds":{"type":"array","description":"Sequence of link ids covered by this toll fee","items":{"type":"integer","description":"Sequence of link ids covered by this toll fee","format":"int64"}},"tollType":{"type":"string","description":"Uppercase letter (A=admin wide, F=system with km/weight/fixed fee, K=kilometer between toll booths based, S=pay per booth or pair of booths) indicates that payment happens here while lowercase (a, f, k, s, p, u) just informs that toll fee exists but is not payed here."},"country":{"type":"string","description":"3 letter ISO 3166 country code","example":"DEU"},"adminId":{"type":"integer","description":"Admin place id of the country","format":"int32"},"tollSystem":{"type":"array","items":{"$ref":"#/components/schemas/TSystem"}},"conditionId":{"type":"integer","description":"Core map condition id, either type Toll Both or Usage Fee Required","format":"int32"},"tollStructures":{"type":"array","description":"Toll booth(s)/bridge(s) at start and/or end of this toll section","items":{"$ref":"#/components/schemas/TollStructure"}},"tollCostAlternatives":{"type":"array","description":"toll fee alternatives, depending on vehicle type, time of day, day of week, month, payment method, pass, transponder...","items":{"$ref":"#/components/schemas/TollCost"}},"usageFeeRequiredTime":{"type":"string","description":"Date/time definition when this toll fee applies, in the same format as in all map layers' DATE_TIMES fields"},"topologySegmentIds":{"type":"array","items":{"type":"integer","format":"int64"}},"fromSegmentIndex":{"type":"integer","description":"Index of the first input segment id covered by this toll fee.","format":"int32"},"toSegmentIndex":{"type":"integer","description":"Index of the last input segment id covered by this toll fee.","format":"int32"}},"description":"routeTollItems are a list of all toll cost items (for rollups=none)."},"Summary":{"type":"object","properties":{"travelTime":{"type":"integer","description":"travel time [sec]","format":"int64","example":455},"distance":{"type":"integer","description":"travel distance [meter]","format":"int64"},"baseTime":{"type":"integer","description":"travel time [sec] without considering traffic impact (use only if mode=traffic:disabled)","format":"int64"},"trafficTime":{"type":"integer","description":"travel time [sec] considering traffic impact (use only if mode=traffic:enabled)","format":"int64"},"flags":{"type":"array","description":"currently unused","example":"boatFerry","items":{"type":"string","description":"currently unused","example":"boatFerry"}},"departure":{"type":"string","description":"same or later than request's departure time","example":"2022-11-16T12:54:14+10"},"arrival":{"type":"string","description":"same or earlier than request's arrival time"}}},"TCResponse":{"type":"object","properties":{"routeTollItems":{"type":"array","description":"routeTollItems are a list of all toll cost items (for rollups=none).","items":{"$ref":"#/components/schemas/RouteTollItem"}},"costsByTollSystem":{"type":"array","description":"costsByTollSystem is the total toll cost per toll system.","items":{"$ref":"#/components/schemas/CurrencyAmount"}},"costsByCountry":{"type":"array","description":"costsByCountry is the total toll cost per country.","items":{"$ref":"#/components/schemas/CurrencyAmount"}},"costsByCountryAndTollSystem":{"type":"array","description":"costsByCountryAndTollSystem is the total toll cost per country and toll system.","items":{"$ref":"#/components/schemas/CurrencyAmount"}},"totalCost":{"$ref":"#/components/schemas/CurrencyAmount"}},"description":"the requested toll cost rollups"},"TSystem":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"languageCode":{"type":"string"}}},"TollCost":{"type":"object","properties":{"amount":{"type":"number","description":"fee in native currency unit","format":"double"},"currency":{"type":"string","description":"the native currency unit"},"amountInTargetCurrency":{"type":"number","format":"double"},"levelOfAccuracy":{"type":"string"},"time":{"type":"string","description":"Standard core map specification for validity periods. Examples: 1:N:N:XXXXXXX:0112:0000:0730,1:N:N:XXXXXXX:0112:1400:1600, 2:N:N:EASTER::800:1800, A:N:N:20021013:20200101:1000:1900, C:N:N:00010000:00050000:1230:1330, H:N:N:00010000:00120000:500:2400 I:N:N:00010010:00110010:1730:2400"},"methodOfPayment":{"type":"integer","description":"bitmask: 1=cash, 2=bank card, 4=credit card, 8=pass subscription, 16=transponder, 32=video toll charge, 64=exact cash, 128=travel card","format":"int32"},"pass":{"$ref":"#/components/schemas/Pass"},"daylightHours":{"type":"integer","description":"Indicates if toll cost is applicable during daylight hours or during non-daylight hours. 0=non-daylight, 1=daylight, 2=unspecified","format":"int32"},"discountAvailable":{"type":"integer","description":"Indicates if under specific circumstances discounts or exemption apply to this standard toll cost. 0=no, 1=yes","format":"int32"},"returnJourney":{"type":"integer","description":"Indicates whether the specified toll cost includes a return trip or not. 0=no, 1=yes","format":"int32"},"ferryType":{"type":"string"},"vehicleSpecification":{"$ref":"#/components/schemas/VehicleSpecification"}},"description":"toll fee alternatives, depending on vehicle type, time of day, day of week, month, payment method, pass, transponder..."},"TollStructure":{"type":"object","properties":{"name":{"type":"string"},"languageCode":{"type":"string","example":"DEU"},"latitude":{"type":"number","format":"double","example":48.33294},"longitude":{"type":"number","format":"double","example":18.13294},"linkIds":{"type":"array","items":{"type":"integer","format":"int64"}},"topologySegmentIds":{"type":"array","items":{"type":"integer","format":"int64"}},"conditionId":{"type":"integer","format":"int32"}},"description":"Toll booth(s)/bridge(s) at start and/or end of this toll section"},"TracePoint":{"required":["matchConfidence","matchedLocation","originalLocation"],"type":"object","properties":{"originalLocation":{"$ref":"#/components/schemas/Location"},"matchedLocation":{"$ref":"#/components/schemas/Location"},"heading":{"type":"number","description":"Heading (aka bearing or direction), in degree against North, clockwise. This value is taken from the request, and provided in the response for convenience. 10000 if not provided in the trace.","format":"double"},"speed":{"type":"number","description":"Speed value, in meter per second (independent of the originally provided unit). This value is taken from the request, and provided in the response for convenience.","format":"double"},"acc":{"type":"number","description":"Longitudinal vehicle acceleration [mpss], breaking if negative.","format":"double"},"timestamp":{"type":"string","description":"Timestamp from original trace in RFC3339 format","format":"date-time","example":"2023-06-15T10:24:52.123Z"},"matchedSegmentIndex":{"type":"integer","description":"Index of topology segment reference in trace point array.","format":"int32"},"matchedSegmentRefOffset":{"type":"number","description":"Trace point's offset on the topology segment reference, 0...1, in segment direction.","format":"double"},"matchConfidence":{"type":"number","description":"Confidence that the trace point belongs to this segment reference, 0...1","format":"double"},"lateralAccelerationMpss":{"type":"number","description":"Driving report attribute, lateral acceleration by centrifugal force [mpss]","format":"double"},"applicableSpeedLimitKph":{"type":"integer","description":"Driving report attribute, speed limit for this vehicle at this date/time, including country wide general limits [kph]","format":"int32"},"accelerationMPSS":{"type":"number","description":"Driving report attribute, longitudinal vehicle acceleration [mpss], breaking if negative.","format":"double"},"solarAltitudeAngle":{"type":"number","description":"Driving report attribute, vertical sun position angle versus the flat earth surface [degree], 90 to -90, 0 = straight into driver's eyes.","format":"double"},"solarRelAltitudeAngle":{"type":"number","description":"Driving report attribute, vertical sun position angle versus the current road surface considering the road slope and heading [degree], 90 to -90","format":"double"},"solarRelHorizontalAngle":{"type":"number","description":"Driving report attribute, horizontal sun position angle versus the driving direction [degree], 0 = straight into driver's eyes, 180 = in the back mirror.","format":"double"}},"description":"GPS trace point"},"TurnByTurnManeuver":{"type":"object","properties":{"routeLinkIndex":{"type":"integer","format":"int32"},"position":{"$ref":"#/components/schemas/ManeuverPosition"},"action":{"type":"string","description":"Indicates whether actions should be included in the maneuvers. Supported actions are: depart, arrive, slightLeftTurn, leftTurn, sharpLeftTurn, leftUTurn , continue, slightRightTurn, rightTurn, sharpRightTurn, rightUTurn, RoundaboutExit, exit, uTurn, turn, keep.","example":"leftTurn"},"orientation":{"type":"string"},"roadName":{"type":"array","items":{"$ref":"#/components/schemas/RoadName"}},"nextRoadName":{"type":"array","items":{"$ref":"#/components/schemas/RoadName"}},"distanceToNextManeuver":{"type":"integer","format":"int32"},"firstPoint":{"type":"integer","description":"Index into the global geometry array, pointing to the first point of the shape subsegment associated with this Maneuver. Must be followed by LastPoint.","format":"int32","example":2},"lastPoint":{"type":"integer","format":"int32"},"travelTime":{"type":"integer","description":"Time [sec] to drive until to this maneuver point","format":"int32","example":150},"instruction":{"type":"string","description":"tagged driver instruction text in the requested language","example":"Head West on M1 / Pacific Mtwy. Go for 56 m."},"instructionBefore":{"type":"string"},"instructionAfter":{"type":"string","example":"After 56 m, take the exit onto 24"},"length":{"type":"integer","description":"Distance [meter] to drive until to this maneuver point","format":"int32"},"id":{"type":"string"},"direction":{"type":"string","description":"Indicates whether directions should be included in the maneuvers. Supported directions are: forward, lightRight, right, hardRight, uTurnRight, lightLeft, left, hardLeft, uTurnLeft."},"lanes":{"type":"string","description":"List of lane infos, viewed into driving direction, from left to right. Applicable lanes marked '*', n = not allowed for vehicle or direction, numbers denote arrows, see Map Attributes layer LANE_FCn attribute DIRECTION_CATEGORY."}}},"VehicleSpecification":{"type":"object","properties":{"trailerType":{"type":"string"},"hybrid":{"type":"boolean"},"emissionType":{"type":"string"},"disabledEquipped":{"type":"boolean"},"hov":{"type":"boolean"},"commercial":{"type":"boolean"},"personFee":{"type":"boolean"},"tollVehicleType":{"type":"string"},"trailersCount":{"type":"integer","format":"int32"},"vehicleNumberAxlesMin":{"type":"integer","format":"int32"},"vehicleNumberAxlesMax":{"type":"integer","format":"int32"},"trailerNumberAxlesMin":{"type":"integer","format":"int32"},"trailerNumberAxlesMax":{"type":"integer","format":"int32"},"heightMin":{"type":"integer","format":"int32"},"heightMax":{"type":"integer","format":"int32"},"trailerHeightMin":{"type":"integer","format":"int32"},"trailerHeightMax":{"type":"integer","format":"int32"},"vehicleWeightMin":{"type":"integer","format":"int32"},"vehicleWeightMax":{"type":"integer","format":"int32"},"limitedWeightMin":{"type":"integer","format":"int32"},"limitedWeightMax":{"type":"integer","format":"int32"},"minimalPollution":{"type":"boolean"},"passengersCountMin":{"type":"integer","format":"int32"},"passengersCountMax":{"type":"integer","format":"int32"},"tiresCountMin":{"type":"integer","format":"int32"},"tiresCountMax":{"type":"integer","format":"int32"},"shippedHazardousGoods":{"type":"string"},"heightAbove1stAxleMin":{"type":"integer","format":"int32"},"heightAbove1stAxleMax":{"type":"integer","format":"int32"},"lengthMin":{"type":"integer","format":"int32"},"lengthMax":{"type":"integer","format":"int32"},"fuelType":{"type":"string"},"co2EmissionClass":{"type":"integer","format":"int32"}}},"WayPoint":{"type":"object","properties":{"linkId":{"type":"string"},"mappedPosition":{"$ref":"#/components/schemas/Coordinate"},"originalPosition":{"$ref":"#/components/schemas/Coordinate"},"spot":{"type":"number","description":"0...1 relative matched offset on link from reference node","format":"double"},"sideOfStreet":{"type":"string","description":"indicates whether the waypoint is on the left or right side of the link in the direction of driving. Possible values are left|right|neither. The value 'neither' means that the waypoint is within 3 meters range away from the link"},"seqNrOnRoute":{"type":"integer","description":"index of the link in the route (duplicate link entries at start/end of a leg are counted only once)","format":"int32"},"globalWayPointSeqNr":{"type":"integer","format":"int32"},"waypointType":{"type":"string","description":"indicate whether waypoint is planned waypoint, learned stop or last tracepoint from RME"},"type":{"type":"string","description":"indicate whether waypoint is passThrough or stopOver"},"mappedRoadName":{"type":"string","description":"Base name of the road. Empty means unknown or valid unnamed."},"shapeIndex":{"type":"integer","description":"index of the first shape coordinate in the shape array","format":"int32"},"userLabel":{"type":"string","description":"Waypoint label specified by user."}}},"Geometry":{"type":"object","properties":{"layerId":{"type":"string","writeOnly":true},"geometry":{"type":"string","description":"WKT string"},"nearestLat":{"type":"number","format":"double"},"nearestLon":{"type":"number","format":"double"},"geometryOverride":{"type":"string","writeOnly":true},"geometryMode":{"type":"string","writeOnly":true,"enum":["NONE","TILED","FULL"]},"distance":{"type":"number","format":"double"},"id":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"type":"string","description":"Attribute/value map"},"description":"Attribute/value map"}}},"MapAttributesV8Response":{"type":"object","properties":{"geometries":{"type":"array","items":{"$ref":"#/components/schemas/Geometry"}},"meta":{"type":"array","items":{"$ref":"#/components/schemas/SearchMetaResponse"}},"Tiles":{"type":"array","items":{"$ref":"#/components/schemas/TileResponseV8"}}}},"MetaResponseV8":{"type":"object","properties":{"layerName":{"type":"string","example":"ROAD_GEOM_FC3"},"tileId":{"type":"integer","format":"int32"},"level":{"type":"integer","format":"int32","example":0},"mapRegion":{"type":"string","example":"WEU"},"mapRelease":{"type":"string","example":"EU"}}},"TileResponseV8":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/TileRow"}},"meta":{"$ref":"#/components/schemas/MetaResponseV8"}}},"TileRow":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"string"}}}},"MapAttributesAlongPathResponse":{"type":"object","properties":{"refReplacements":{"type":"object","additionalProperties":{"type":"string","description":"Replacements for $0, $1, ... in the segmentRef designations."},"description":"Replacements for $0, $1, ... in the segmentRef designations."},"segments":{"type":"array","description":"List of segments in input order. Each segmentRef comes with a fixed set of attributes, if any attribute changes within a segment a new SegmentRef object is created.","items":{"$ref":"#/components/schemas/SegmentRefAttributes"}}}},"SegmentRefAttributes":{"type":"object","properties":{"segmentRef":{"type":"string","description":"SegmentRef in the shortened notation:
$0:{layerId}?:partitionId:$1:segmentId#{dir}startOffset..endOffset
Content of placeholders $0, $1 provided by refReplacements. layerId is not defined and omitted partitionId is always calculated for level 12, and might differ from notations using different levels. Dir can be '+' or '-' indicates the direction of the segmentRef."},"attributes":{"type":"object","additionalProperties":{"type":"array","description":"Requested attributes for the segmentRef grouped by layers.","items":{"type":"array","description":"Requested attributes for the segmentRef grouped by layers.","items":{"$ref":"#/components/schemas/KeyValue"}}},"description":"Requested attributes for the segmentRef grouped by layers."}},"description":"List of segments in input order. Each segmentRef comes with a fixed set of attributes, if any attribute changes within a segment a new SegmentRef object is created."},"GeometrySearchResponse":{"type":"object","properties":{"geometries":{"type":"array","items":{"$ref":"#/components/schemas/Geometry"}},"meta":{"type":"array","items":{"$ref":"#/components/schemas/SearchMetaResponse"}}}},"Feature":{"required":["geometry","properties","type"],"type":"object","properties":{"type":{"type":"string","description":"GeoJSON feature"},"geometry":{"$ref":"#/components/schemas/Geometry"},"properties":{"$ref":"#/components/schemas/Properties"}},"description":"GeoJSON feature objects"},"Properties":{"type":"object","properties":{"provider":{"type":"string","description":"Optional trace point property specifying provider"},"timestamp":{"type":"integer","description":"Optional trace point property specifying logged timestamp","format":"int64"},"unixtime":{"type":"integer","description":"Optional trace point property specifying logged timestamp","format":"int64"},"timestamp_msec":{"type":"integer","description":"Optional trace point property specifying logged timestamp","format":"int64"},"timestamp_local":{"type":"integer","description":"Optional trace point property specifying logged timestamp of local time","format":"int64"},"heading":{"type":"number","description":"Optional trace point property specifying heading","format":"double"},"bearing":{"type":"number","description":"Optional trace point property specifying heading","format":"double"},"direction":{"type":"number","description":"Optional trace point property specifying heading","format":"double"},"velocity":{"type":"number","description":"Optional trace point property specifying speed","format":"double"},"speed_mps":{"type":"number","description":"Optional trace point property specifying speed","format":"double"},"speed_kmh":{"type":"number","description":"Optional trace point property specifying speed","format":"double"},"altitude":{"type":"number","description":"Optional trace point property specifying elevation","format":"double"},"elevation":{"type":"number","description":"Optional trace point property specifying elevation","format":"double"}},"description":"GeoJSON feature properties"},"TraceGeoJson":{"type":"object","properties":{"type":{"type":"string","description":"GeoJSON FeatureCollection"},"features":{"type":"array","description":"GeoJSON feature objects","items":{"$ref":"#/components/schemas/Feature"}}},"description":"GPS trace in GeoJson Format"},"VehicleSpec":{"type":"object","properties":{"shippedHazardousGoods":{"type":"array","description":"A comma-separated list of hazardous goods being shipped in the vehicle","items":{"type":"string","description":"A comma-separated list of hazardous goods being shipped in the vehicle","enum":["explosive","gas","flammable","combustible","organic","poison","radioactive","corrosive","poisonousInhalation","harmfulToWater","other"]}},"trailerType":{"type":"string","description":"Define the trailer type. RV = Recreational vehicle.","enum":["none","caravan","trailer","rvTrailer","boatTrailer"]},"axleCount":{"type":"integer","description":"Total number of axles the vehicle has, i.e., axles on the base vehicle and any attached trailers.","format":"int32"},"trailerAxleCount":{"type":"integer","description":"Total number of axles across all the trailers attached to the vehicle.","format":"int32"},"height":{"type":"integer","description":"Actual height of the overall vehicle including trailers, specified in centimeters.","format":"int32"},"width":{"type":"integer","description":"Actual width of the overall vehicle including trailers, specified in centimeters.","format":"int32"},"length":{"type":"integer","description":"Length of the vehicle (including potential trailers), specified in centimeters.","format":"int32"},"trailerLength":{"type":"integer","description":"Sum of length of the trailers, specified in centimeters.","format":"int32"},"trailerWidth":{"type":"string","description":"Trailer width, specified in centimeters."},"grossWeight":{"type":"integer","description":"Actual total weight of vehicle including trailers and shipped goods, specified in kilograms.","format":"int32"},"trailerWeight":{"type":"string","description":"Actual total weight of trailers and shipped goods, specified in kilograms."},"weightPerAxleGroup":{"type":"string","description":"Specifies the weights of different axle groups, such as single and tandem axles. Comma separated list of vehicle weight in kilograms per axle group. Format: AxleGroup1:Weight1[,AxleGroup2:Weight2]...\nAllowed axle-groups are: \n-single \n-tandem \n-triple \n-quad \n-quint","example":"single:11,tandem:18"},"weightPerAxle":{"type":"string","description":"Vehicle weight per axle, specified in kilograms."},"grossWeightClass":{"type":"integer","description":"Legal maximum weight limit of vehicle including trailers and shipped goods, specified in kilograms.","format":"int32"},"tireCount":{"type":"integer","description":"Number of tires of vehicle and trailers","format":"int32"},"commercial":{"type":"boolean","description":"Is the vehicle registered for commercial use? Default is false for passenger cars and true for trucks, buses and taxis."},"tunnelCategory":{"type":"string","description":"Defines the tunnel categories the truck must NOT use. B, C, D or E. A tunnels have no restrictions. E tunnels have most restrictions. If C is defined, the route will use A and B tunnels but not C, D or E.","enum":["A","B","C","D","E"]}},"description":"Vehicle parameters to be used during route matching."},"ResponseError":{"required":["action","cause","code","correlationId","status","title"],"type":"object","properties":{"title":{"type":"string","description":"Human readable error description","example":"Input data failed validation"},"status":{"type":"integer","description":"HTTP status code","format":"int32"},"code":{"type":"string","description":"Machine readable service error code.\nAll error codes of this service start with \"`E627`\". The last three digits describe a specific error. Provide this error code when contacting support.\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| Code | Reason |\n| --------- | ------- |\n| `E62700X` | Malformed query. Typically due to invalid values such as `transportMode=submarine` or missing required fields. Check the error message for details. |\n","example":"Input data failed validation"},"cause":{"type":"string","description":"Human readable explanation for the error","example":"The input data in question does not meet validation rules."},"action":{"type":"string","description":"Human readable action that can be taken to correct the error","example":"Request a valid id"},"correlationId":{"type":"string","description":"Unique ID of the request which triggered this error."}}},"AuthError":{"type":"object","properties":{"error":{"type":"string","description":"Error message.","example":"Unauthorized"},"error_description":{"type":"string","description":"Detailed information about the error.","example":"ApiKey invalid. ApiKey not found."}},"description":"Error object reported in case of authentication or authorization errors"},"BaseNoticeDetail":{"required":["type"],"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**NOTE:** The list of possible detail types may be extended in the future.\nThe client application is expected to handle such a case gracefully."}},"description":"Additional details about the notice"},"Location":{"required":["lat","lng"],"type":"object","properties":{"lat":{"type":"number","description":"WGS84 latitude","format":"double"},"lng":{"type":"number","description":"WGS84 longitude","format":"double"},"elv":{"type":"number","description":"elevation in meter height above the WGS84 reference ellipsoid. This value is taken from the request, and provided in the response for convenience.","format":"double"}},"description":"Location on the Earth"},"Notice":{"required":["code"],"type":"object","properties":{"title":{"type":"string","description":"Human-readable notice description.","example":"Trace point far away from its neighbors"},"code":{"type":"string","description":"Notice code.","example":"tracePointCouldNotBeMatched"},"severity":{"type":"string","description":"Describes the impact a notice has on the resource to which the notice is attached.\n* critical - The notice must not be ignored, even if the type of notice is not known to the user.\n* info - The notice is for informative purposes, but does not affect usability of the matched path.","enum":["critical","info"]},"details":{"type":"array","description":"Additional details about the notice","items":{"$ref":"#/components/schemas/BaseNoticeDetail"}},"tracePointIndex":{"type":"integer","description":"Sequence number of the trace point this notice refers to.","format":"int32"},"pathSegmentIndex":{"type":"integer","description":"Sequence number of the segment ref in the path this notice refers to.","format":"int32"}},"description":"Notice to inform/warn customer or end user on problems in the trace"},"Path":{"type":"object","properties":{"name":{"type":"string","description":"main = most probably driven path, e-horizon = electronic horizon path ahead"},"segments":{"type":"array","description":"Path segments in traversal order","items":{"$ref":"#/components/schemas/Segment"}},"polyline":{"type":"string","description":"Polyline for the path in [Flexible Polyline](https://github.com/heremaps/flexible-polyline) Encoding.","example":"A05xgKuy2xCx9B7vUl0OhnR54EqSzpEl-HxjD3pBiGnyGi2CvwFsgD3nD4vB6e"},"transportModeLikelihoods":{"type":"array","description":"Likelihood for vehicle types / transport modes","items":{"$ref":"#/components/schemas/TransportModeLikelihood"}},"notices":{"type":"array","description":"Alerts and notifications along the path and trace points","items":{"$ref":"#/components/schemas/Notice"}},"refReplacements":{"type":"object","additionalProperties":{"type":"string","description":"Text replacements in the response, caller has to replace $3 by the definition listed here. Only numbers used as keys. Mainly for repeating parts in segment references."},"description":"Text replacements in the response, caller has to replace $3 by the definition listed here. Only numbers used as keys. Mainly for repeating parts in segment references."}},"description":"Sequence of most probably driven segments, or e-horizon segment sequence, or ETA tracking upcoming segment sequence."},"RouteMatchResponse":{"required":["paths","tracePoints"],"type":"object","properties":{"tracePoints":{"type":"array","description":"Sequence of trace points","items":{"$ref":"#/components/schemas/TracePoint"}},"paths":{"type":"array","description":"List of paths - not alternatives, but different paths depending on route matching mode.","items":{"$ref":"#/components/schemas/Path"}}},"description":"Route Match Response"},"Segment":{"type":"object","properties":{"segmentRef":{"type":"string","description":"Topology segment reference including start and end offset on the segment and driving direction."},"functionalClass":{"type":"integer","description":"Functional road class of the segment ref.","format":"int32"},"length":{"type":"number","description":"Length of the driven offset range on this segment in meters.","format":"double"},"duration":{"type":"integer","description":"Time to traverse the driven offset range of this segment ref in seconds.","format":"int64"},"matchConfidence":{"type":"number","description":"Confidence 0..1 that the trace met this segment.","format":"double"},"offset":{"type":"integer","description":"Offset of a coordinate in the path's polyline.","format":"int32"}},"description":"Topology segment that trace points are matched to"},"TransportModeLikelihood":{"title":"TransportModeLikelihood","type":"object","properties":{"type":{"type":"string","description":"Transport mode or vehicle type: bicycle, bus, car, heavyTruck, lightTruck, mediumTruck or pedestrian."},"confidence":{"type":"number","description":"Confidence 0..1 that the trace was using this transport/vehicle.","format":"double"}},"description":"Likelihood for vehicle types / transport modes"},"LayerUploadResponse":{"type":"object","properties":{"storedTilesCount":{"type":"integer","format":"int32"}}},"LayerModifyResponse":{"type":"object","properties":{"action":{"type":"string"}}},"FailedConstraint":{"type":"object","properties":{"constraint":{"type":"string","description":"The constraint reflects the input setting in the same format."},"reason":{"type":"integer","description":" The reason defines why the constraint was not met: 0:Undetermined, 1:not reachable in time, 2:service time did not fit, 3: conflicts with arrival time of final waypoint.","format":"int32"}},"description":"List containing pairs of unmet constraints and reasons."},"Interconnection":{"type":"object","properties":{"fromWaypoint":{"type":"string","description":"Waypoint of the sequence to be reached next."},"toWaypoint":{"type":"string","description":"Waypoint of the sequence to be reached next."},"distance":{"type":"number","description":"Distance between the two waypoints","format":"double"},"time":{"type":"number","description":"Time needed for traveling between the two waypoints","format":"double"},"rest":{"type":"number","description":"Rest time at or between the waypoints","format":"double"},"waiting":{"type":"number","description":"Waiting time at the destination","format":"double"},"warnings":{"type":"array","description":"Warnings for traveling between the two waypoints. Example: Route violates requested 'avoid' options or legal/physical restrictions","items":{"$ref":"#/components/schemas/WseIssue"}}},"description":"Timings and distances to travel from one waypoint to the next waypoint of the sequence"},"OutOfSequenceWaypoint":{"type":"object","properties":{"id":{"type":"string","description":"User provided id"},"lat":{"type":"number","description":"Latitude of the waypoint","format":"double"},"lng":{"type":"number","description":"Longitude of the waypoint","format":"double"},"failedConstraints":{"type":"array","description":"List containing pairs of unmet constraints and reasons.","items":{"$ref":"#/components/schemas/FailedConstraint"}}}},"Result":{"type":"object","properties":{"waypoints":{"type":"array","description":"Waypoints in the order of the calculated sequence","items":{"$ref":"#/components/schemas/Waypoint"}},"distance":{"type":"string","description":"Overall distance to travel the whole sequence in meter"},"time":{"type":"string","description":"Overall time to travel the whole sequence in seconds"},"interconnections":{"type":"array","description":"Timings and distances to travel from one waypoint to the next waypoint of the sequence","items":{"$ref":"#/components/schemas/Interconnection"}},"description":{"type":"string","description":"Human readable description of the optimization goals"},"timeBreakdown":{"$ref":"#/components/schemas/TimeBreakdown"},"baseTime":{"type":"string","writeOnly":true}},"description":"This List contains 1 or 0 elements with an ordered list of waypoints. This value is set, if a result is found."},"TimeBreakdown":{"type":"object","properties":{"driving":{"type":"integer","description":"Time spent in motion for completing the sequence in seconds","format":"int32"},"service":{"type":"integer","description":"Active time spent at the waypoints in seconds","format":"int32"},"rest":{"type":"integer","description":"Time needed for resting according to legal regulations (simplified model) in seconds","format":"int32"},"waiting":{"type":"integer","description":"Time spent waiting at the waypoints in seconds","format":"int32"}},"description":"Time needed for traveling through the sequence by categories."},"Warnings":{"type":"object","properties":{"outOfSequenceWaypoints":{"type":"array","items":{"$ref":"#/components/schemas/OutOfSequenceWaypoint"}}},"description":"This List contains 0 or more elements with an ordered list of waypoints. This value is set only, if no sequence is found due to constraints."},"Waypoint":{"type":"object","properties":{"id":{"type":"string","description":"User provided id"},"lat":{"type":"number","description":"Latitude of the waypoint","format":"double"},"lng":{"type":"number","description":"Longitude of the waypoint","format":"double"},"sequence":{"type":"integer","description":"Position in the sequence","format":"int32"},"estimatedArrival":{"type":"string","description":"Expected time of arrival at the waypoint"},"estimatedDeparture":{"type":"string","description":"Expected time of departure from the waypoint, based on estimated arrival time and the service time at the waypoint"},"fulfilledConstraints":{"type":"array","description":"User specified constraints of the waypoint, which have been met","items":{"type":"string","description":"User specified constraints of the waypoint, which have been met"}}},"description":"Waypoints in the order of the calculated sequence"},"WseIssue":{"type":"object","properties":{"message":{"type":"string","description":"Warning/error message"},"code":{"type":"integer","description":"Warning/error code","format":"int32"}},"description":"Warnings for traveling between the two waypoints. Example: Route violates requested 'avoid' options or legal/physical restrictions"},"WseResponse":{"type":"object","properties":{"results":{"type":"array","description":"This List contains 1 or 0 elements with an ordered list of waypoints. This value is set, if a result is found.","items":{"$ref":"#/components/schemas/Result"}},"errors":{"type":"array","description":"This field provides descriptions of errors which occurred during the calculation. The value is always included in the answer, but is a empty array, if there is no error. errors is providing information if the HTTP response code indicates an error.","items":{"type":"string","description":"This field provides descriptions of errors which occurred during the calculation. The value is always included in the answer, but is a empty array, if there is no error. errors is providing information if the HTTP response code indicates an error."}},"processingTimeDesc":{"type":"string","description":"Calculation time for the result, including the time unit. If the response does not contains an error, the processing time value is included."},"responseCode":{"type":"string","description":"This value is set to the HTTP response code. If the parameter jsonCallback is set in the request, the HTTP response code is always 200. In this case this field gives the actual response code."},"warnings":{"$ref":"#/components/schemas/Warnings"},"requestId":{"type":"string","description":"Identifier defined in the request and passed through the system. This field is null, if no such value was defined in the request."}}},"Version":{"required":["apiVersion"],"type":"object","properties":{"name":{"type":"string"},"apiVersion":{"type":"string"},"repositoryRevisionNumber":{"type":"string"}}},"MapDocBean":{"type":"object","properties":{"name":{"type":"string"},"coverage":{"type":"string"},"version":{"type":"integer","format":"int64"},"releaseYearAndQuarter":{"type":"string"},"size":{"type":"integer","format":"int64"},"isLatest":{"type":"boolean"},"layerNames":{"type":"array","items":{"type":"string"}},"mapType":{"type":"string"},"storage":{"type":"string"}}},"MapDocResponse":{"type":"object","properties":{"maps":{"type":"array","items":{"$ref":"#/components/schemas/MapDocBean"}}}},"LayerDocBean":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"tileLevel":{"type":"integer","format":"int32"},"level":{"type":"integer","format":"int32"},"attributes":{"type":"array","items":{"type":"string"}},"layerType":{"type":"string"},"storage":{"type":"string"},"mapName":{"type":"string"},"featureMapping":{"type":"string"},"dynamicLayerAttribute":{"type":"boolean","writeOnly":true}}},"LayerDetailDocBean":{"type":"object","properties":{"description":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"referencedStaticContents":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"tileRequestsLevel":{"type":"integer","format":"int32"},"tileX":{"type":"integer","format":"int32"},"tileY":{"type":"integer","format":"int32"},"isStaticContent":{"type":"boolean"},"dynamicLayerAttributeDocDescription":{"type":"boolean","writeOnly":true}}},"AttributeDocBean":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"layers":{"type":"array","items":{"type":"string"}}}},"IndexDocBean":{"type":"object","properties":{"indexedLayerName":{"type":"string"},"indexedColumnNames":{"type":"string"},"indexType":{"type":"string"},"exampleNames":{"type":"string"},"exampleUrlParams":{"type":"string"},"mapName":{"type":"string"}}},"IndexResponse":{"type":"object","properties":{"Layers":{"type":"array","description":"List of layers containing this attribute value. Usually 1 layer, but can be multiple when request a ..._FCN layer.","items":{"$ref":"#/components/schemas/IndexResponseLayer"}}}},"IndexResponseLayer":{"type":"object","properties":{"layer":{"type":"string"},"level":{"type":"integer","description":"Tiling level of the layer.","format":"int32"},"tileXYs":{"type":"array","description":"tileX and tileY components of the tile ID.","items":{"$ref":"#/components/schemas/IndexTileCoords"}}},"description":"List of layers containing this attribute value. Usually 1 layer, but can be multiple when request a ..._FCN layer."},"IndexTileCoords":{"type":"object","properties":{"x":{"type":"integer","format":"int32"},"y":{"type":"integer","format":"int32"}},"description":"tileX and tileY components of the tile ID."},"DeleteLayersResponse":{"type":"object","properties":{"deletedLayers":{"type":"array","items":{"type":"string"}}}},"HealthStatus":{"type":"object","properties":{"status":{"type":"string"}}},"OpenapiResponse":{"type":"object","description":"API response for the openapi endpoint"},"ListLayersResponse":{"type":"object","properties":{"layers":{"type":"array","items":{"type":"string"}}}},"LayerPermissionResponse":{"type":"object"},"ListLayerAttributesResponse":{"type":"object","properties":{"column":{"type":"array","items":{"$ref":"#/components/schemas/MetaDataInfo"}}}},"MetaDataInfo":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"Center":{"type":"object","properties":{"linkId":{"type":"string"},"mappedPosition":{"$ref":"#/components/schemas/Coordinate"},"originalPosition":{"$ref":"#/components/schemas/Coordinate"},"sideOfStreet":{"type":"string","description":"indicates whether the waypoint is on the left or right side of the link in the direction of driving. Possible values are left|right|neither. The value 'neither' means that the waypoint is within 3 meters range away from the link"},"globalWayPointSeqNr":{"type":"integer","format":"int32"},"waypointType":{"type":"string","description":"indicate whether waypoint is planned waypoint, learned stop or last tracepoint from RME"},"type":{"type":"string","description":"indicate whether waypoint is passThrough or stopOver"},"mappedRoadName":{"type":"string","description":"Base name of the road. Empty means unknown or valid unnamed."},"shapeIndex":{"type":"integer","description":"index of the first shape coordinate in the shape array","format":"int32"},"userLabel":{"type":"string","description":"Waypoint label specified by user."}}},"Component":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"shape":{"type":"array","items":{"type":"number","format":"double"}},"links":{"type":"array","items":{"$ref":"#/components/schemas/IsolineLink"}}}},"Isoline":{"type":"object","properties":{"range":{"type":"number","format":"double"},"rangeType":{"type":"string"},"component":{"type":"array","items":{"$ref":"#/components/schemas/Component"}}}},"IsolineLink":{"type":"object","properties":{"linkId":{"type":"string"},"functionalClass":{"type":"integer","description":"Functional Class defines a hierarchical network used to determine a logical and efficient route.","format":"int32"},"shape":{"type":"array","items":{"type":"number","format":"double"}}}},"IsolineResponse":{"type":"object","properties":{"start":{"$ref":"#/components/schemas/Center"},"destination":{"$ref":"#/components/schemas/Center"},"isoline":{"type":"array","items":{"$ref":"#/components/schemas/Isoline"}}}},"MetaResponse":{"type":"object","properties":{"layerName":{"type":"string"},"tileX":{"type":"string"},"tileY":{"type":"string"},"level":{"type":"string"},"rowCount":{"type":"string"},"mapRegion":{"type":"string"},"mapRelease":{"type":"string"}}},"TileResponse":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/TileRow"}},"meta":{"$ref":"#/components/schemas/MetaResponse"}}},"ServiceConfigurationContent":{"type":"object","properties":{"maxTilesPerRequest":{"type":"string"},"maxIndexValuesPerRequest":{"type":"string"},"maxGetLinkInfoLinkIdsPerRequest":{"type":"string"},"maxProximityLayers":{"type":"string"},"maxSearchResults":{"type":"string"}}},"ServiceConfigurationResponse":{"type":"object","properties":{"Configuration":{"$ref":"#/components/schemas/ServiceConfigurationContent"}}},"StaticContentDocBean":{"type":"object","properties":{"name":{"type":"string"},"attributes":{"type":"array","items":{"type":"string"}},"referencingLayers":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"StaticContentDetailDocBean":{"type":"object","properties":{"description":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"referencingLayers":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}}}}}