Real-Time Incident Information for the given id

get

https://data.traffic.hereapi.com/v7/incidents/{originalId}

Get traffic incident for a given id. The id can be prefixed with a namespace. If no namespace is specified, the default namespace is "here:traffic:incident".

Path Params

originalId

string

required

Identifier of the first traffic incident in a chain of updates. Once an incident chain has been created, this value will never change.

Query Params

locationReferencing

array of strings

required

length ≥ 1

The location referencing scheme (or schemes) to be used in the response. Multiple location referencing schemes can be specified separated by commas (,).

Location Referencing	Description
`none`	The response will not contain any location references such as tmc, olr, HMC topology segments or shape points.
`olr`	Open Location References is a TISA location referencing standard also called TPEGOpenLR. Please visit https://tisa.org/ for more details. TISA Specifications are also published by ISO https://www.iso.org/ Specifications: ISO/TS 21219-22:2017
`shape`	Shape points. Defines a location by a series of geo-coordinates.
`tmc`	Traffic Message Channel (TMC) location referencing method uses tables of pre-coded locations. For details please refer ISO specifications ISO 14819-3:2013 and ISO 14819-2:2013.
`segmentRef`	Topology Segment references. Defines a location by a series of reference to the HMC Topology Segment.

lang

string

The language to be used for the incident descriptions. Parameter value must follow specification: BCP47. Supported values are available on iana.org

units

string

enum

Defaults to metric

Units of measurement to be used in incident descriptions. The default is metric.

Allowed:

useRefReplacements

boolean

Defaults to true

Use replacement strings for compact representation of HMC topology segment references.

Headers

X-Request-Id

string

User-provided token that can be used to trace a request or a group of requests sent to the service. This can be any string but UUID is preferred.

Responses

200Incident item response for specified original id

400Failure to parse the request, it may have invalid incident id or query parameters.

401Authentication Failed

403Not allowed, such as trying to request fields without having the necessary permissions.

404Failure to parse the request, caused by, for example, invalid parameter values such as in=planet:mars.

414API response in case of too long uri.

500Internal server error.

503Service unavailable.