Map Attributes along a route path.

get

https://smap.hereapi.com/v8/maps/attributes/path

The path endpoint can be used to enrich a given continuous route path with HERE Map content attributes.

Note: We recommend using POST requests for large payloads, as GET requests may be constrained by request-line length limits imposed by load balancers.

Query Params

app_id

string

app_code

string

mapName

string

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

attributes

string

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.

segmentRefs

string

Semicolon seperated list of consecutive topology segment references. Supported segment reference input are: Segment References in shortened or full notation, links or flexiblePolyline. The input is typically retrieved from the Route Matching, Routing v8 API. A shortened segment reference looks like: $1:864623000#+0..1 where $1 the provider part. A full segment reference looks like: here:cm:segment:92174667#0.517718..0.785. Input methods like links, flexiblePolyline or segment input cannot be mixed with each other.

links

string

Link IDs or Full notation to define the path. Cannot be mixed with parameter segments, flexiblePolyline.

flexiblePolyline

string

Line string in Flexible Polyline format. Cannot be mixed with parameter segments, links.

transportMode

string

Optional, default=car. Relevant if 'applicable speed limits layer'. Supported vehicle types: bdouble, bicycle, bus, car, carHOV, emergency, motorcycle, pedestrian, roadtrain, taxi, truck, motorhome

departure

string

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.

trailerType

string

Trailer type in a vehicle + trailer combination. Supported values: 0 - None (Default), 1 - Caravan, 2 - Trailer, 3 - RVTrailer, 4 - BoatTrailer. Applicable for toll cost calculation and recreational vehicle restrictions.

vehicleNumberAxles

string

Number of vehicle axles excluding trailer axles. Applicable for toll cost calculation and country wide truck restrictions.

trailerNumberAxles

string

Number of trailer axles. Applicable for toll cost calculation and for country wide truck restrictions.

hybrid

string

Type of hybrid vehicle. Supported values: 1 - fuel+electric, 0 - otherwise (Default). Applicable for toll cost calculation.

emissionType

string

Emission type category of the vehicle. supported values: 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 (deprecated), 10 - EURO III with PRC (deprecated), 11 - EURO VII.

Applicable for toll cost calculation and environmental zone restrictions.
When emissionType is not specified it defaults to 5.

co2EmissionClass

string

CO2 emission class of the vehicle. Supported values: 1 - Emission class 1, 2 - Emission class 2, 3 - Emission class 3, 4 - Emission class 4, 5 - Emission class 5.

Applicable for toll cost calculation 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.

trailerHeight

string

Actual height of the trailer(s). Accepted value units are cm (centimeter), m (meter) or in (inch). Example: 350cm or 3.5m or 138in. For toll cost calculation only, not considered for route path creation (use height parameter).

vehicleWeight

string

Actual total weight of vehicle incl. payload, but not trailers' weight or payload. Accepted value units are t (tons), kg (kilograms) or lbs (pounds). Example: 7.5t or 7500kg or 16500lbs. See also limitedWeight. Applicable for toll cost calculation only.

vehicleWeightClass

string

Used in routeMatch=0|1|2. Legal maximum weight limit of vehicle incl. payload and trailers. Also including their payload as a total. Accepted value units are t (tons), kg (kilograms) or lbs (pounds). Example: 7.5t or 7500kg or 16500lbs. Applicable for truck restrictions and requests for APPLICABLE_SPEED_LIMIT only.

disabledEquipped

string

Vehicle is signposted to to carry disabled people. Accepted values are: 1 - vehicle equipped to carry disabled people, 0 - otherwise (default). Applicable for toll cost calculation only.

passengersCount

string

Actual number of passengers in vehicle. Applicable for toll cost calculation only.

tiresCount

string

Total number of tires from vehicle, including tires on the base vehicle and any attached trailers. Applicable for toll cost calculation only.

commercial

string

Vehicle use has commercial purpose. Accepted values are: 1 - vehicle registered for commercial use, 0 - no commercial use (Default: not specified). Applicable for toll cost calculation, environmental zone regulations and delivery-only zones.

heightAbove1stAxle

string

Height of the vehicle above its first axle. Example: 350cm or 3.5m or 138in. Applicable for toll cost calculation only.

fuelType

string

Defines the fuel powering the vehicle. Supported values: Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric, LPG - Liquefied Petroleum Gas, LNG - Liquefied Natural Gas).
Applicable for environmental zone restrictions, toll cost calculation and consumption based routing for Electric vehicles.

weightPerAxleGroup

string

Semicolon separated list of vehicle weight [tons] per axle group. Each item is a tuple (name,value). Supported values: drive, single, tandem, triple, quad, quint. Example: &weightPerAxleGroup=drive:12;single:11;tandem:18 .

trailerWeight

string

Actual total weight of trailers with their payload. Accepted value units are t (tons), kg (kilograms) or lbs (pounds). Example: 7.5t or 7500kg or 16500lbs. See also parameter limitedWeight. Applicable for toll cost calculation only.

trailersCount

string

Number of trailers or semi-trailers. For toll cost and truck restrictions.

Supported values: 0 - no trailer (default), 1 - one or more trailers, 2 - two or more trailers, 3 - three or more trailers, 4 - one or more semi-trailers.
&trailersCount=4 is not supported for Waypoint Sequencing.

height

string

Actual height of the overall rigid/semi truck including trailers. Accepted value units are cm (centimeter), m (meter) or in (inch). Example: 350cm or 3.5m or 138in. Applicable for truck restrictions and toll cost.

limitedWeight

string

Actual total weight of vehicle incl. payload and trailers/caravan including their payload.

Accepted value units are t (tons), kg (kilograms) or lbs (pounds).
Example: 7.5t or 7500kg or 16500lbs.
Applicable for truck restrictions, speed profile selection, toll cost calculation and environmental zone restrictions. See also parameter vehicleWeight.
Note that country wide weight restrictions depend on the length, width, number of axles and trailers as well, so it might be necessary to specify these parameters as well.

shippedHazardousGoods

string

Comma separated list from supported values: explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable.

Applicable for toll cost calculation and truck restrictions.
For toll cost only values explosive and other are supported.
For Waypoints Sequence values allhazardousGoods and explosiveFlammable are not supported.

length

string

Length of the vehicle (including potential trailers).

Accepted value units are cm (centimeter), m (meter) or in (inch). Example: 1250cm or 12.5m or 492in.
Applicable for toll cost calculation and truck restrictions.
Note that country wide length restrictions depend on the limitedWeight, width, number of axles and trailers as well, so it might be necessary to specify these parameters as well.

weightPerAxle

string

Actual total weight per axle, incl. payload.

Accepted value units are t (tons), kg (kilograms) or lbs (pounds).
Example: 7.5t or 7500kg or 16500lbs.
For Waypoints Sequence only supported unit is kg, without explicitly specifying unit.
Applicable for toll cost calculation and truck restrictions.

width

string

Width of the vehicle and trailer(s). Accepted value units are cm (centimeter), m (meter) or in (inch). Example: 350cm or 3.5m or 138in. Applicable for truck restrictions. Note that country wide width restrictions depend on the limitedWeight, length, number of axles and trailers as well, so it might be necessary to specify these parameters as well.

tunnelCategory

string

Defines the tunnel categories the truck must NOT use. Supported values: B, C, D or E.

A tunnels have no restrictions.
E tunnels have most restrictions.
Example: If &tunnelCategory=C is specified, then route will use A and B tunnels but not C, D or E.

timeout

string

Operation must be finished within this amount of milliseconds. Default 50000. Maximum 50000.

apiKey

string

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 authentication options are Bearer token, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html or app_id with app_code for backward compatibility.

Response

200OK