API Changes

The sections below list APIs that were added, changed, or removed.

Added on 2025-05-16

Added typeDescription field in incident response to support incident type translations.

Example:

{
    "criticality": "minor",
    "type":"disabledVehicle",
    "typeDescription": {
        "value": "Liegengebliebenes Fahrzeug",
        "language": "de-DE"
    },
    "codes":[735],
    "description": {
        "value":"Wegen Baustelle gesperrt",
        "language":"de-DE"
    },
    "summary": {
        "value":"Wegen Baustelle gesperrt",
        "language":"de-DE"
    },
    "junctionTraversability": "intermediateClosedEdgeOpen"
}

For supported languages, there is a localized description of the incident type value in the typeDescription field.

Added on 2024-01-11

Added support for using POST method to pass all parameters as JSON data.

POST payload example:

{
    "in": {
        "type": "bbox",
        "west": 13.386969,
        "south": 52.527129,
        "east": 13.424134,
        "north": 52.549420
    },
    "locationReferencing": [
        "olr"
    ],
    "functionalClasses": [
        4,
        5
    ],
    "criticality": [
        "critical",
        "major",
        "minor"
    ],
    "type": ["construction"],
    "earliestStartTime": 1637730069,
    "latestEndTime": 1704783973,
    "lang": "DE",
    "units": "metric"
}

The new method helps avoid the situation which API request sometimes has a too large value for URI length limit (i.e. 1000 characters). That is likely to be the case for request by topology segment reference.

Changed on 2022-05-19

The /incidents/{originalId} endpoint now accepts a namespace prefix. If a namespace is not specified, here:traffic:incident is assumed by default.

Both variants are accepted:

here:traffic:incident:3879526487457467809
3879526487457467809

Response JSON will now contain also HRN notation for both id and original_id.

Example:

"incidentDetails": {
    "id": "3848418285967206000",
    "hrn": "here:traffic:incident:3848418285967206000",
    "originalId": "2349753562597427700",
    "originalHrn": "here:traffic:incident:2349753562597427700",
    "roadClosed": true