TomTom Traffic Incidents – Intermediate Service – DATEX II

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, travel weather warnings, 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.

This document gives basic information on the Service and shows how to configure it to work with your environment. The fields are described in two sets of tables. One that defines them in a logical way, and the other describes in detail how they are represented in DATEX II format. Basic knowledge of installing and using XML-based schemas is necessary.

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

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 physical representation in DATEX II can be found below in the section, Standard information.

The Service provides users traffic incident data with highly customizable optional configuration, in addition to the standard configuration.

Detailed information about the physical representation in DATEX II can be found below in the section, Optional information.

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

If you make the following request:

You can expect the following response:

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:

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.

TomTom extended the data model with additional fields; the full XSD schema including extensions can be downloaded by clicking this link. 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).

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.

The DATEX II data model has been extended to allow additional parameters. Some of these extensions are needed for the standard feed information (see also Standard configurations).

<situationRecord [...]>
  [...]
  <validity>
    <validityStatus>active</validityStatus>
    <validityTimeSpecification>
      <overallStartTime>2020-11-04T08:00:00Z</overallStartTime>
    </validityTimeSpecification>
  </validity>
  [...]
</situationRecord>

<groupOfLocations>
  <locationContainedInGroup xsi:type="Linear">
    <locationExtension>
      <openlr>
        <binary version="3">CwkmCSJZIRtmJQiDBE4bEg==</binary>
      </openlr>
    </locationExtension>
  </locationContainedInGroup>
</groupOfLocations>

<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>
</groupOfLocations>

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

<situationRecord xsi:type="AbnormalTraffic" [...]>
  [...]
  <abnormalTrafficExtension>
    <averageSpeed>18.0</averageSpeed>
  </abnormalTrafficExtension>
</situationRecord>

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

<situationRecord [...]>
  [...]
  <situationRecordExtension>
    <alertCEventCode>115</alertCEventCode>
  </situationRecordExtension>
</situationRecord>

<situationRecord [...]>
  [...]
  <generalPublicComment>
    <comment>
      <value lang="en">The pass is free in both directions.</value>
    <comment>
  </generalPublicComment>
</situationRecord>