Traffic Incidents - DATEX II

Last edit: 2025.03.13

TomTom Maps

Purpose

The TomTom Traffic Incidents - Intermediate Service - DATEX II (hereafter called 'Service') is based on DATEX II v1.0. DATEX II is a standard for information exchange between traffic control centers, service providers, and application developers.

The Service provides the latest real-time information about traffic incidents, their causes and impacts on travelers. Typical traffic incidents include accidents, road construction projects, traffic jams, road closures, and any other road-related situation that could potentially cause a delay.

In this document, we discuss how to access the Service and the features that are included.

Important
TomTom only supports the Intermediate Service with the use of the TomTom customized DATEX II schema, available for download from our website (linked previously and later in this document). Using the Service with the standard DATEX II schema will disable the functionality that is included with the Service. Therefore, the standard DATEX II schema is not supported.

Scope

This document gives basic information on the Service and shows how to configure it to work with your environment. Basic knowledge of installing and using XML-based schemas is necessary.

Intended audience

This information is intended to be used by TomTom partners and customers (decision makers and developers).

Features

TomTom offers traffic incident data to customers. In the basic configuration, TomTom provides customers information on traffic congestion and other roadwork-related traffic events.

Each traffic incident is represented in a DATEX II event, and we add an Alert-C event code with the same meaning. This Alert-C event code allows the user to customize the content at their own discretion. This information is organized by country-based datasets. The product is static. This means that the included regions and features are fixed once the product is configured. Products are customer-specific.

Detailed information about the default enabled features and their representation in DATEX II can be found in the section Default enabled information.

The Service provides users traffic incident data with a highly customizable optional configuration, in addition to the features enabled by default. The section Optionally activatable features provides detailed information about these configurations and their representation in DATEX II.

Request data

The Service uses RESTful API (Representation State Transfer) technology. Since you only need to use one URL, the Service is relatively uncomplicated to use.

'Simple HTTP server' profile

The interface supports the client pull method, also known as the simple HTTP server profile. The profile is described in the Software Developers Guide and Exchange Platform Specific Model (see the DATEX II payload specification for the links to the documents). TomTom does not support the SOAP envelope as described in the Software Developers Guide.

Important
To use this service, ensure that all prerequisites are met as described in the section, A secure connection or at Authentication for client certificate access.

How do you make a request?

To make a request, the URL should be constructed as shown in the following sections.

HTTPS Method: `GET`

For ease of viewing and identification:

Constants and parameters enclosed in curly brackets { } must be replaced with their values.
Please see the following Request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.

The sample URL is formatted as follows:

get

URL format

https://{baseURL}/tsq/hdt/{productName}/{apiKey}/content.xml

The following is an example URL:

get

URL example

https://cert-traffic.tomtom.com/tsq/hdt/DEU-HDT-OPENLR/{Your_API_Key}/content.xml

The following is an example cURL request:

get

cURL request example

curl --compressed -XGET 'https://cert-traffic.tomtom.com/tsq/hdt/DEU-HDT-OPENLR/{Your_API_Key}/content.xml'

Request parameters

The following table provides a detailed explanation of the available fields that were previously shown in the HTTPS Method: GET section.

Required parameters	Description
`baseURL` string	Base URL for calling the API. Value: `cert-traffic.tomtom.com`
`productName` string	Name of the product (feed) you are requesting. These will be indicated to you as part of the provisioning process. Typically, it explains the country (country code), and the location referencing method (see Location referencing). Examples: `DEU-OPENLR`, `DEU-TMC`
`apiKey` string	Authorization key for access to the API. Value: Your valid API key.

Request headers

Since incident feeds can be very large, TomTom recommends optimizing the information transmission as much as possible. By doing this, the client receives more up-to-date information.

All responses will be gzip compressed as it significantly reduces the payload size. The use of the HTTP header Accept-Encoding is required. For more information see our page about Gzip compression.

Headers	Description
If-Modified-Since	TomTom recommends using the standard HTTP header `If-Modified-Since` with the last value of `Last-Modified` received. When this header is used properly, you avoid unnecessarily downloading identical content. For details, see the HTTP/1.1 standard (RFC2616 section 14.25). Example: `Wed, 21 Oct 2015 07:28:00 GMT`

Response data

Response codes

Response code	Description
200 OK	Indicates that the request has succeeded. The response body will contain the requested data.
304 Not Modified	Only used if the `If-Modified-Since` header has been set by the client. Indicates that the requested data has not been modified since the last request. For more information see Request headers.
401 Unauthorized	Indicates that the request requires user authentication information. The client MAY repeat the request with a suitable Authorization header field.
406 Not Acceptable	The server doesn't find any content that conforms with the `Accept-Encoding` header sent in the request. This may happen if `Accept-Encoding` is set to `identity` or `gzip;q=0` or if no `Accept-Encoding` header is present. If the `Accept-Encoding` header is not set or does not support gzip, the server will return a 406 status code with a message indicating the issue.

Response example

This is a response you receive after a request is made. If you make the following request:

get

URL example

https://cert-traffic.tomtom.com/tsq/hdt/DEU-HDT-OPENLR/{Your_API_Key}/content.xml

You can expect the following response:

Response example - XML
1<?xml version="1.0" encoding="UTF-8"?>
2<d2LogicalModel xmlns="http://datex2.eu/schema/1_0/1_0" modelBaseVersion="1.0">
<exchange>
  <supplierIdentification>
    <country>nl</country>
    <nationalIdentifier>TomTom Traffic Service</nationalIdentifier>
  </supplierIdentification>
</exchange>
<payloadPublication xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SituationPublication" lang="en">
  <publicationTime>2023-10-10T12:44:30Z</publicationTime>
  <publicationCreator>
    <country>other</country>
    <nationalIdentifier>71553ccb-728e-4ee3-9717-4afd308ce0f3</nationalIdentifier>
  </publicationCreator>
  <situation id="TTI-71553ccb-728e-4ee3-9717-4afd308ce0f3-TTL25838637712020000">
    <headerInformation>
      <confidentiality>internalUse</confidentiality>
      <informationStatus>real</informationStatus>
      <urgency>urgent</urgency>
    </headerInformation>
    <situationRecord xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AbnormalTraffic" id="TTI-71553ccb-728e-4ee3-9717-4afd308ce0f3-TTL25838637712020000-1">
      <situationRecordCreationTime>2023-10-10T12:44:13Z</situationRecordCreationTime>
      <situationRecordVersion>7</situationRecordVersion>
      <situationRecordVersionTime>2023-10-10T12:44:30Z</situationRecordVersionTime>
      <situationRecordFirstSupplierVersionTime>2023-10-10T12:44:30Z</situationRecordFirstSupplierVersionTime>
      <probabilityOfOccurrence>certain</probabilityOfOccurrence>
      <validity>
        <validityStatus>definedByValidityTimeSpec</validityStatus>
        <validityTimeSpecification>
          <overallStartTime>2023-10-10T12:44:13Z</overallStartTime>
        </validityTimeSpecification>
      </validity>
      <impact>
        <delays>
          <delayTimeValue>131.0</delayTimeValue>
        </delays>
      </impact>
      <groupOfLocations>
        <locationContainedInGroup xsi:type="Linear">
          <locationExtension>
            <openlr>
              <binary version="3">C81gjx4aeyOABwEMAWEjEw==</binary>
            </openlr>
          </locationExtension>
        </locationContainedInGroup>
      </groupOfLocations>
      <situationRecordExtension>
        <alertCEventCode>108</alertCEventCode>
      </situationRecordExtension>
      <abnormalTrafficType>queueingTraffic</abnormalTrafficType>
      <abnormalTrafficExtension>
        <averageSpeed>9.1</averageSpeed>
      </abnormalTrafficExtension>
    </situationRecord>
  </situation>
56
57[...]
58
</payloadPublication>
60</d2LogicalModel>

Response – DATEX II payload specification (analysis of the received output)

The payload in the output is formatted as DATEX II, which is a European standard for the exchange of Traffic and Travel Information. TomTom supports version 1. Recommended documents are:

DATEX II v1.0 User Guide version 1.0 ( DATEXIIv1.0-UserGuide_v1.0.pdf )
DATEX II v1.0 Software Developers Guide version 1.0 ( DATEXIIv1.0-DevGuide_v1.0.pdf )
DATEX II v1.0 Exchange Platform Specific Model version 1.0 ( DATEXIIv1.0-ExchangePSM_v1.0.pdf )
A browsable DATEX II version 1.0 data dictionary ( DATEXIIv1.0-DataDictionnary_v1.0.zip )

The Elaborated Data Publication, used by TomTom, is described in more detail in section 4.11 of the DATEX II User Guide version 1.0.

Important: XSD schema
TomTom extended the data model with additional fields; the full XSD schema including extensions can be downloaded by clicking this Level B extension. It is a "Level B" extension of the standard XML schema: DATEXIISchema_1_0_1_0.xsd. Such an extension is interoperable with the "Level A" data model (see section 2.2.3 in the DATEX II User Guide version 1.0 for more information).

How the data is organized

Situation publication

The traffic information is provided as a SituationPublication. A SituationPublication is the snapshot of the latest traffic data. A SituationPublication can contain several different situations.

The service does not support a delta mechanism. Therefore, incremental updates are not possible.

Situation

A situation represents a traffic or travel incident comprising one or more traffic or travel circumstances. These are linked by one or more causal relationships and apply to related locations. Each traffic or travel circumstance is represented by a SituationRecord.

Situation record

A SituationRecord is one element of a situation. It is characterized by values at a given time, defining one version of this element. When these values change, a new version is created. One SituationRecord can be:

a road or traffic related event (traffic element)
an operator action
a piece of information that is based on a non-road event

and can contain:

an advisory
details that impact the estimated time of arrival

Unique identifier

Each Situation has a unique identifier. Additionally, every SituationRecord also has a unique identifier. This identifier is established when the Situation or SituationRecord is first created in the DATEX II system database. As long as the situation exists, this identifier will always be present within the system. The unique identifier has a fixed prefix "TT", followed by a string. No further assumptions should be made about the identifier.

The identifier is unique across all supported countries.

Impact

If the current delay is available for a SituationRecord, the delayTimeValue is provided in the Impact. If there is information about closed lanes, because of an accident or other incident, it can be populated in ImpactDetails.

In some cases, there are multiple SituationRecords that are related to each other. For instance, there can be a traffic jam that is caused by an accident. If the locations of these SituationRecords overlap or are connected AND they occur in the same direction, then the SituationRecords are contained in the same Situation. In that case, a single Situation contains more than one SituationRecord.

Sometimes, it is possible that two SituationRecords are related to each other, but do not overlap. For instance, one SituationRecord contains a diversion advice, located at a highway intersection. Since the road is blocked farther along the segment, that is described in a different SituationRecord. In that case, the SituationPublication does not contain a reference from one SituationRecord to the other.

For the first example, consider combining the information from the SituationRecords in your end application to let the end-user know there is a delay due to an accident. In the second example, there is a diversion due to a road closure.

Default enabled information

The DATEX II data model has been extended to allow additional parameters. Some of these extensions are needed for the standard feed information and are explained in the following sections.

Validity period

Field

Field	`validity` (`SituationRecord`)
Description	Specifies the validity of a `SituationRecord`. The validity status and the start time of the event as part of the validity time specification are provided. A `SituationRecord` has a validity period that is comprised of: a mandatory `validityStatus,` a mandatory `overallStartTime`, which indicates the start of the `SituationRecord`, if it is in the past, or an expected start date, if it is in the future. The Incident end time and Future incidents are optional features and not part of the standard information.

validity (SituationRecord)

Description

Specifies the validity of a SituationRecord. The validity status and the start time of the event as part of the validity time specification are provided. A SituationRecord has a validity period that is comprised of:

a mandatory validityStatus,
a mandatory overallStartTime, which indicates the start of the SituationRecord, if it is in the past, or an expected start date, if it is in the future.

The Incident end time and Future incidents are optional features and not part of the standard information.

Example
1<situationRecord [...]>
[...]
<validity>
  <validityStatus>active</validityStatus>
  <validityTimeSpecification>
    <overallStartTime>2022-10-10T08:00:00Z</overallStartTime>
  </validityTimeSpecification>
</validity>
[...]
10</situationRecord>

Location referencing

Field

Field	`groupOfLocations` (`SituationRecord`)
Description	Every `SituationRecord` contains a `groupOfLocations`, which describes the involved location. The Location is defined in section 4.16 of the DATEX II User Guide. TMC and OpenLR (binary version 3) are the location referencing methods supported by the Service. The feeds can be configured to only contain TMC, only OpenLR or both location referencing methods. Note that situation records whose location is outside the TMC network will not be contained in feeds configured for only TMC. The individual types are examined in more detail below. OpenLR location referencing OpenLR (see http://www.openlr.org) is a dynamic location referencing method that allows referencing of any road on the complete digital map. Because of its flexibility, it is possible to describe traffic events on high-level and lower-level road classes that are not usually covered by the Traffic Message Channel (TMC). TomTom uses the terms TMC and Alert-C interchangeably throughout this documentation; they have the same meaning. OpenLR is available free of charge. The Service uses binary format version 3, as described in the OpenLR whitepaper. The whitepaper, software developer kit, and open source reference implementations are available for download from the OpenLR website. TomTom offers support for third parties to implement and test their own implementations. TMC (Alert-C) location referencing The TMC feed uses Alert-C as the location referencing method. See section 4.16.5 in the DATEX II User Guide for more information. An Alert-C location reference contains a reference to a specific version of a TMC Location Table. TMC allows referrals to AREA, POINT, or LINEAR locations. Either Method2 or Method4 is used in the feed, depending on the availability of offset(s). If offset information is available, Method4 is used to identify an exact location. If the exact length of the location is available, it is provided as `lengthAffected` in a `supplementaryPositionalDescription`. Note: There is a difference between the direction of TMC LINEAR location in the incident feed and the flow feeds that we support. The TMC LINEAR location in the incident feed does not need to be inverted (unlike the flow feed)! Additionally, the direction is implicitly stated by the primary and secondary locations.

groupOfLocations (SituationRecord)

Description

Every SituationRecord contains a groupOfLocations, which describes the involved location. The Location is defined in section 4.16 of the DATEX II User Guide. TMC and OpenLR (binary version 3) are the location referencing methods supported by the Service.

The feeds can be configured to only contain TMC, only OpenLR or both location referencing methods. Note that situation records whose location is outside the TMC network will not be contained in feeds configured for only TMC. The individual types are examined in more detail below.

OpenLR location referencing

OpenLR (see http://www.openlr.org) is a dynamic location referencing method that allows referencing of any road on the complete digital map. Because of its flexibility, it is possible to describe traffic events on high-level and lower-level road classes that are not usually covered by the Traffic Message Channel (TMC). TomTom uses the terms TMC and Alert-C interchangeably throughout this documentation; they have the same meaning. OpenLR is available free of charge. The Service uses binary format version 3, as described in the OpenLR whitepaper. The whitepaper, software developer kit, and open source reference implementations are available for download from the OpenLR website. TomTom offers support for third parties to implement and test their own implementations.

TMC (Alert-C) location referencing

The TMC feed uses Alert-C as the location referencing method. See section 4.16.5 in the DATEX II User Guide for more information. An Alert-C location reference contains a reference to a specific version of a TMC Location Table. TMC allows referrals to AREA, POINT, or LINEAR locations. Either Method2 or Method4 is used in the feed, depending on the availability of offset(s). If offset information is available, Method4 is used to identify an exact location. If the exact length of the location is available, it is provided as lengthAffected in a supplementaryPositionalDescription.
Note: There is a difference between the direction of TMC LINEAR location in the incident feed and the flow feeds that we support. The TMC LINEAR location in the incident feed does not need to be inverted (unlike the flow feed)! Additionally, the direction is implicitly stated by the primary and secondary locations.

Example: only OpenLR
1<groupOfLocations>
<locationContainedInGroup xsi:type="Linear">
  <locationExtension>
    <openlr>
      <binary version="3">CwkmCSJZIRtmJQiDBE4bEg==</binary>
    </openlr>
  </locationExtension>
</locationContainedInGroup>
9</groupOfLocations>

Example: only TMC
1<groupOfLocations>
<locationContainedInGroup xsi:type="Linear">
  <supplementaryPositionalDescription>
    <lengthAffected>87.0</lengthAffected>
  </supplementaryPositionalDescription>
  <alertCLinear xsi:type="AlertCMethod4Linear">
    <alertCLocationCountryCode>D</alertCLocationCountryCode>
    <alertCLocationTableNumber>1</alertCLocationTableNumber>
    <alertCLocationTableVersion>18.0</alertCLocationTableVersion>
    <alertCDirection>
      <alertCDirectionCoded>positive</alertCDirectionCoded>
    </alertCDirection>
    <alertCMethod4PrimaryPointLocation>
      <alertCLocation>
        <specificLocation>30920</specificLocation>
      </alertCLocation>
      <offsetDistance>
        <offsetDistance>1359</offsetDistance>
      </offsetDistance>
    </alertCMethod4PrimaryPointLocation>
    <alertCMethod4SecondaryPointLocation>
      <alertCLocation>
        <specificLocation>30929</specificLocation>
      </alertCLocation>
      <offsetDistance>
        <offsetDistance>0</offsetDistance>
      </offsetDistance>
    </alertCMethod4SecondaryPointLocation>
  </alertCLinear>
</locationContainedInGroup>
31</groupOfLocations>

Example: TMC + OpenLR
1<groupOfLocations>
<locationContainedInGroup xsi:type="Linear">
  <locationExtension>
    <openlr>
      [binary]
    </openlr>
  </locationExtension>
  <supplementaryPositionalDescription>
    [affected length]
  </supplementaryPositionalDescription>
  <alertCLinear xsi:type="AlertCMethod4Linear">
      [TMC location reference information]
  </alertCLinear>
</locationContainedInGroup>
15</groupOfLocations>

Average speed for jams

Field	`averageSpeed` (`AbnormalTrafficExtensionType`)
Description	The average speed for congestion events, in km/h.

Example
1<situationRecord xsi:type="AbnormalTraffic" [...]>
2  [...]
3  <abnormalTrafficExtension>
4    <averageSpeed>18.0</averageSpeed>
5  </abnormalTrafficExtension>
6</situationRecord>

Delay for jams

Field	`impact` (`SituationRecord`)
Description	The `impact` provides information on the delay of congestion events in seconds. Delay information for journalistic events is offered as part of the optional feature Average speed for journalistic events.

Example
1<situationRecord xsi:type="AbnormalTraffic" [...]>
[...]
<impact>
  <delays>
    <delayTimeValue>64.0</delayTimeValue>
  </delays>
</impact>
[...]
9</situationRecord>

Alert-C event codes

Field	`alertCEventCode` (`SituationRecordExtensionType`)
Description	The Alert-C event code describing the `SituationRecord`. There can be zero or more codes. It is highly recommended to use `alertCEventCode` to classify the incident and map it to a list of categories that are to be supported (e.g., traffic jams, road closures, road works, lane closures, accidents, etc.)

Example
1<situationRecord [...]>
2  [...]
3  <situationRecordExtension>
4    <alertCEventCode>115</alertCEventCode>
5  </situationRecordExtension>
6</situationRecord>

Refer to ISO TS 14819-2 at https://www.iso.org for Alert-C codes and conventions.

Language-specific texts

Field	`generalPublicComment` (`SituationRecord`)
Description	A `SituationRecord` may contain language-specific text. For example, this can be a diversion advice, provided by the network manager, or some other free text. Typically, this text is available only in the language of the country. The information is reported as a (list of) `generalPublicComment` element(s).

Example
1<situationRecord [...]>
2  [...]
3  <generalPublicComment>
4    <comment>
5      <value lang="en">The pass is free in both directions.</value>
6    <comment>
7  </generalPublicComment>
8</situationRecord>

Probability of occurrence

Field	`probabilityOfOccurrence` (`SituationRecord`)
Description	The semantics of this field are deprecated and will be removed in the future. Do not use. The reason why this attribute is used at all is that in DATEX II v1.0 it is a mandatory field.

Example
1<situationRecord [...]>
2  [...]
3  <probabilityOfOccurrence>probable</probabilityOfOccurrence>
4  [...]
5</situationRecord>

Optionally activatable features

The DATEX II data model has been extended to allow additional parameters. The Service has the following possible extensions.

Incident end time

Field

Field	`overallEndTime` (`OverallPeriod`)
Description	This option predicts the expected ending time for the traffic incident such as the expected end time of a jam or a closure. This field is expressed as a UTC time (e.g., 14:22 UTC). These end times may be created by TomTom or originate from local road authorities (for journalistic events).

overallEndTime (OverallPeriod)

Description

This option predicts the expected ending time for the traffic incident such as the expected end time of a jam or a closure.

This field is expressed as a UTC time (e.g., 14:22 UTC). These end times may be created by TomTom or originate from local road authorities (for journalistic events).

Example
1<situationRecord [...]>
[...]
<validity>
  <validityStatus>definedByValidityTimeSpec</validityStatus>
  <validityTimeSpecification>
  <overallStartTime>2023-10-10T08:00:00Z</overallStartTime>
  <overallEndTime>2023-11-13T00:00:00Z</overallEndTime>
  </validityTimeSpecification>
</validity>
[...]
11</situationRecord>

Jam tendency

Field

Field	`trafficTrendType` (`AbnormalTraffic`)
Description	This feature indicates whether a jam is improving, remaining stable, or becoming worse. The feature is supported for the situation record type `AbnormalTraffic`. The following values may be present: `trafficBuildingUp` `trafficEasing` `trafficStable` `unknown`

trafficTrendType (AbnormalTraffic)

Description

This feature indicates whether a jam is improving, remaining stable, or becoming worse. The feature is supported for the situation record type AbnormalTraffic. The following values may be present:

trafficBuildingUp
trafficEasing
trafficStable
unknown

Example
1<situationRecord [...] xsi:type="AbnormalTraffic" [...]>
2  [...]
3  <trafficTrendType>trafficBuildingUp</trafficTrendType>
4  [...]
5</situationRecord>

Important
This feature is now offered as part of the TomTom Hazard Warnings product.

Field

Field	`poorEnvironmentType` (`PoorEnvironmentConditions`)
Description	This feature reports messages for road segments that could be impacted by severe weather. Snow or heavy rain conditions use suitable Alert-C event codes and DATEX II classifications. The following Alert-C event codes and weather conditions are used: Alert-C event code 1101 (snow), poor environment condition `heavySnowfall` Alert-C event code 1106 (hail), poor environment condition `hail` Alert-C event code 1107 (sleet), poor environment condition `sleet` Alert-C event code 1109 (heavy rain), poor environment condition `heavyRain`

poorEnvironmentType (PoorEnvironmentConditions)

Description

This feature reports messages for road segments that could be impacted by severe weather. Snow or heavy rain conditions use suitable Alert-C event codes and DATEX II classifications. The following Alert-C event codes and weather conditions are used:

Alert-C event code 1101 (snow), poor environment condition heavySnowfall
Alert-C event code 1106 (hail), poor environment condition hail
Alert-C event code 1107 (sleet), poor environment condition sleet
Alert-C event code 1109 (heavy rain), poor environment condition heavyRain

Jam ahead warnings

Important
This feature is now offered as part of the TomTom Hazard Warnings product.

Fields

Fields	`openlr` (`LocationExtensionType`) `averageSpeed` (`AbnormalTrafficExtensionType`)
Description	Selecting this option generates special warning messages when a location registers high-speed differences. Specifically, when the tail end of the jam is projected to intercept oncoming traffic, creating a potentially dangerous situation. The user can enable messages for only jam-ahead warnings or have them delivered next to all regular messages. An OpenLR point along line reference is used for this message. The jam ahead warning is recognized by a `locationContainedInGroup` with type `Point` in combination with the presence of an `averageSpeed`.

openlr (LocationExtensionType)
averageSpeed (AbnormalTrafficExtensionType)

Description

Selecting this option generates special warning messages when a location registers high-speed differences. Specifically, when the tail end of the jam is projected to intercept oncoming traffic, creating a potentially dangerous situation. The user can enable messages for only jam-ahead warnings or have them delivered next to all regular messages.

An OpenLR point along line reference is used for this message. The jam ahead warning is recognized by a locationContainedInGroup with type Point in combination with the presence of an averageSpeed.

Example
1<situationRecord [...] xsi:type="AbnormalTraffic" [...]>
[...]
<groupOfLocations>
  <locationContainedInGroup xsi:type="Point">
    <locationExtension>
      <openlr>
        <binary version="3">KwchAiYFHQEfGf8LBSABUEc=</binary>
      </openlr>
    </locationExtension>
  </locationContainedInGroup>
</groupOfLocations>
[...]
<abnormalTrafficExtension>
  <averageSpeed>29.0</averageSpeed>
</abnormalTrafficExtension>
16</situationRecord>

Average speed for journalistic events

Fields

Fields	`averageSpeed` (`AccidentExtensionType`, `ConditionsExtensionType`, `EnvironmentalObstructionExtensionType`, `EquipmentDamageObstructionExtensionType`, `GeneralObstructionExtensionType`, `OperatorActionExtensionType`, `PoorRoadInfraStructureExtensionType`) `impact` (`SituationRecord`)
Description	Selecting this option adds the average speed values for journalistic messages (for example, road works, or lane restrictions). This is the average speed as measured by TomTom. We created DATEX II extensions for each journalistic event type that supports speeds (also see Fields above). In addition to the speed information the delay is indicated as part of the `impact`.

averageSpeed (AccidentExtensionType, ConditionsExtensionType, EnvironmentalObstructionExtensionType, EquipmentDamageObstructionExtensionType, GeneralObstructionExtensionType, OperatorActionExtensionType, PoorRoadInfraStructureExtensionType)
impact (SituationRecord)

Description

Selecting this option adds the average speed values for journalistic messages (for example, road works, or lane restrictions). This is the average speed as measured by TomTom.

We created DATEX II extensions for each journalistic event type that supports speeds (also see Fields above). In addition to the speed information the delay is indicated as part of the impact.

Example: A GeneralObstruction element with an averageSpeed
1<situationRecord [...] xsi:type="GeneralObstruction" [...]>
[...]
<impact>
  <delays>
    <delayTimeValue>34.0</delayTimeValue>
  </delays>
</impact>
[...]
<generalObstructionExtension>
  <averageSpeed>59.6</averageSpeed>
</generalObstructionExtension>
12</situationRecord>

All other extension types listed under Field work the same way as GeneralObstruction.

Turn-dependent jams

Field

Field	`conditionalOffset` (`SituationRecordExtensionType`)
Description	Selecting this option provides the user with turn-dependent jams information. The user receives messages when a portion of the jam is projected to affect travel only if following in the direction of the jam. Common use cases include: congestion on exit ramps, entry ramps, turn-lanes, and so on. To find the actual affected location, the (conditional) offset must be applied from the end of the location.

conditionalOffset (SituationRecordExtensionType)

Description

Selecting this option provides the user with turn-dependent jams information. The user receives messages when a portion of the jam is projected to affect travel only if following in the direction of the jam. Common use cases include: congestion on exit ramps, entry ramps, turn-lanes, and so on.

To find the actual affected location, the (conditional) offset must be applied from the end of the location.

Example
1<situationRecord [...]>
2  [...]
3  <situationRecordExtension>
4    <alertCEventCode>115</alertCEventCode>
5    <conditionalOffset>151</conditionalOffset>
6  </situationRecordExtension>
7  [...]
8</situationRecord>

HOV jams

Field	`lanes` (`SupplementaryPositionalDescription`)
Description	Selecting this option provides the user with high-occupancy vehicle (HOV) jams information. This feature is only available in combination with the location referencing method OpenLR. The `lanes` indicator `carPoolLanes` identifies HOV lanes.

Example
1<situationRecord [...]>
[...]
<groupOfLocations>
  <locationContainedInGroup xsi:type="Linear">
    <locationExtension>
      <openlr>
        <binary version="3">KwSSoyRHmAEVCP18/zsBRds=</binary>
      </openlr>
    </locationExtension>
    <supplementaryPositionalDescription>
      <lanes>carPoolLane</lanes>
    </supplementaryPositionalDescription>
  </locationContainedInGroup>
</groupOfLocations>
[...]
16</situationRecord>

Incident node name

Fields	`fromNodeName` (`LocationExtensionType`) `toNodeName` (`LocationExtensionType`)
Description	Selecting this option provides node names for cross-streets at the beginning and end of the road segment.

Example
1<situationRecord [...]>
[...]
<groupOfLocations>
  <locationContainedInGroup xsi:type="Linear">
    <locationExtension>
      [...]
      <fromNodeName>
    <name>Globe St/S Main St (Broadway St/MA-138)</name>
      </fromNodeName>
      <toNodeName>
    <name>I-195 (Broadway St/MA-138)</name>
      </toNodeName>
      [...]
    </locationExtension>
  </locationContainedInGroup>
</groupOfLocations>
[...]
18</situationRecord>

Road number

Field	`roadNumber` (`LocationExtensionType`)
Description	Selecting this option provides the road identifier or road number of the affected location.

Example: Road number of the German freeway (Autobahn) A3
1<situationRecord [...]>
[...]
<groupOfLocations>
  <locationContainedInGroup xsi:type="Linear">
    <locationExtension>
      [...]
      <roadNumber>A3</roadNumber>
    </locationExtension>
  </locationContainedInGroup>
</groupOfLocations>
[...]
12</situationRecord>

Future incidents

Fields	`overallStartTime` (`OverallPeriod`) `validityStatus` (`Validity`)
Description	Selecting this option includes incidents whose start time is in the future (for example, planned roadworks, or road closures). The field is expressed as a UTC time (e.g., 14:22 UTC). The start time of future incidents is after the publication time. The `validityStatus` of the message is set to `suspended`.

Example
1<?xml version="1.0" ?>
2<d2LogicalModel
xmlns="http://datex2.eu/schema/1_0/1_0"
modelBaseVersion="1.0">
[...]
<payloadPublication
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:type="SituationPublication" lang="en">
  <!-- time when snapshot was created -->
  <publicationTime>2023-10-10T00:00:00Z</publicationTime>
  <situation [...]>
    <situationRecord [...]>
      [...]
      <validity>
        <validityStatus>suspended</validityStatus>
        <validityTimeSpecification>
          <!-- start time of the incident -->
          <overallStartTime>2023-10-15T00:00:00Z</overallStartTime>
        </validityTimeSpecification>
      </validity>
      [...]
    </situationRecord>
  </situation>
</payloadPublication>
25<d2LogicalModel/>

Map version

Field	`mapVersion` (`PayloadPublicationExtensionType`)
Description	This option provides the names and versions of the maps that were used to create the content.

Example
1<?xml version="1.0" encoding="UTF-8"?>
2<d2LogicalModel xmlns="http://datex2.eu/schema/1_0/1_0" modelBaseVersion="1.0">
[...]
<payloadPublication
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:type="SituationPublication" lang="en">
  [...]
  <payloadPublicationExtension>
<mapVersion>nam2023.06.060</mapVersion>
  </payloadPublicationExtension>
  <!-- list of situation elements follows -->
  [...]
</payloadPublication>
14</d2LogicalModel>

Traffic Incidents - DATEX II

Purpose

Important

Scope

Intended audience

Features

Request data

'Simple HTTP server' profile

Important

How do you make a request?

HTTPS Method: GET

Request parameters

Request headers

Response data

Response codes

Response example

Response – DATEX II payload specification (analysis of the received output)

Important: XSD schema

How the data is organized

Situation publication

Situation

Situation record

Unique identifier

Impact

Related situation records

Default enabled information

Validity period

Location referencing

OpenLR location referencing

TMC (Alert-C) location referencing

Average speed for jams

Delay for jams

Alert-C event codes

Language-specific texts

Probability of occurrence

Optionally activatable features

Incident end time

Jam tendency

Weather-related messages

Important

Jam ahead warnings

Important

Average speed for journalistic events

Turn-dependent jams

HOV jams

Incident node name

Road number

Future incidents

Map version

HTTPS Method: `GET`