Incident data provides information about discrete events that affect specific sections of a roadway. Some examples of events are closures, road works, and accidents.
There are two mandatory request parameters when getting flow or incident data.
For more information, see the respective concept pages:
in- geospatial filter
locationReferencing- location references to be returned
Additionally, there are further optional filter parameters:
functionalClassesfilters the locations in the response by the Functional Road Class of the roadway that is represented. For further details, see the flow use case Filter Incidents by Functional Class.
criticalityfilters by the incident criticality field
typefilters by the incident type field
latestEndTimefilter by the incident
lang parameter is used to request that the incident
summary fields are returned in a specific language. For further details, see the incidents tutorial Request incidents in a different language.
A request can also be made for a single incident by ID. The value of the
originalId field should be used (See IDs below for further information on the available fields). In this case, only the
locationReferencing parameter is mandatory and the
in parameter cannot be used.
For further details, see the incidents use case Request Incident by ID.
The response from the incidents endpoint provides a list of incident objects together with the last updated time of the source data.
When an incident is requested by ID, then a single incident object is returned instead of a list.
Each incident object consists of a
location field containing a location reference and an
incidentDetails field containing the specific details of the incident.
The location reference object is described under Location Referencing.
Each incident may have a number of IDs attached.
id- identifier for the incident version; may change on updates to the same incident.
originalId- identifier of the first incident in a chain of updates. This value is stable across updates to the incident.
parentId- identifier of another incident to which this incident is linked. For example, if the incident is a congestion item caused by an accident, this identifier would refer to the accident incident.
Each incident contains two fields that specify which event the incident represents.
type field is an enumerated value that gives a general group for the incident. This enum may be extended in the future. The current values are:
accident- indicates that there has been a collision
construction- indicates that building or roadworks are taking place
congestion- indicates that there has been a build-up of vehicles
disabledVehicle- indicates that a vehicle is unable to move and is obstructing the road
massTransit- indicates that an event is present related to public transit
plannedEvent- indicates that an organised event is taking place causing disruption
roadHazard- indicates that there are dangerous objects on the surface of the road
roadClosure- indicates that the road has been closed, for example, by the police
weather- indicates that weather conditions are causing disruptions
laneRestriction- indicates that some of the lanes have access restrictions
other- indicates that an incident not explainable with the types above has occurred
codes field gives a prioritised list of codes which describe the cause of the incident according to the AlertC specification.
The codes are given in order of importance, so the first item in the list is considered the primary cause of the incident.
The full list of codes in the AlertC specification can be found in ISO 14819-2:2013.
The criticality field represents the severity of the incident. It has the following values:
low- least severe
critical- most severe
Criticality can be used to provide visual indications for a user interface, but no further information should be inferred from its value.
An incident may have up to three time fields. All fields are formatted as per RFC 3339, Section 5.6 as defined by
date-time. The times are always given in UTC explicitly (strings end in
startTime- the time from which the incident is valid, before this time the incident should not be considered.
endTime- the time until which the incident is valid, after this time the incident should not be considered.
entryTime- the time the incident was entered into the system.
The incident will always contain a flag
roadClosed to indicate whether the incident prevents travel along the roadway.
Indicates junction traversability. Used for road closures to indicate if the junctions along the closure can be crossed.
allOpen- all junctions are open
allClosed- all junctions are closed
intermediateClosedEdgeOpen- junctions at beginning and end of the roadway are open, intermediate junctions are closed
startOpenOthersClosed- first edge junction is open, all others are closed
endOpenOthersClosed- last edge junction is open, all others are closed
The default value is
allOpen and the field will only be present if the value differs from this default.
A list of restrictions that apply to vehicles that can traverse the specified roadways. The restrictions are temporary and apply as long as the incident is present. If a vehicle fall under the conditions of the restriction, it's not allowed to pass through that area.
Each restriction in the list has a vehicle type and a restriction type. The current values for vehicle type are:
Restriction types can be one of the followings:
sizeRestriction- a restriction on either height, length or width of the vehicle in centimeters. This restriction has a
dimensionfield which defines to which dimension the restriction applies, and a
valuefield which defines the restriction value with either
weightRestriction- a restriction on the weight of the vehicle in kilograms. This restriction has a
weight_typefield which defines the weight type to be either
grossWeight, and a
valuefield which defines the value with either
vehicleOccupancyRestriction- a restriction on the number of passengers in a car. It has a single value with either
emissionRestriction- A restriction on the emission class of the vehicle. Possible values are:
equipmentTypeRestriction- A restriction on the vehicles equipment. Possible values are:
fuelTypeRestriction- A restriction on the vehicle's fuel type. Possible values are:
TrafficTypeRestriction- A restriction on the type of traffic. Possible values are:
plateNumberRestriction- A restriction on the vehicle's plate number. Possible values are:
Each incident contains two textual fields describing the incident in human-readable language. These fields are appropriate to be displayed to an end user.
summary field provides a short version of the description containing no location information.
description field provides a longer textual description, possibly with location information.