Developer

Status by Id

Service version: v1
Last edit: 2023.02.28

Purpose

The Status by Id endpoint provides Live Traffic Status for a selected location.

Request data

HTTPS Method: GET

  • 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 these values. The generic URL format is as follows.

URL format

get
URL request example
https://enterprise-api.rer.tomtom.com/api/v1/locations/{locationId}/liveStatus?key={Your_API_Key}

curl command format

get
Request curl command example
curl 'https://enterprise-api.rer.tomtom.com/api/v1/locations/{locationId}/liveStatus?key={Your_API_Key}'

Request parameters

The following table describes the parameters that can be used in a request.

  • Required parameters must be used or the call will fail.
  • Optional parameters may be used.

Note: There are no optional parameters in this endpoint.

Required parameters

Description

baseURL
string

Base URL for calling the API.
Value: enterprise-api.rer.tomtom.com

versionNumber
string

Service version.
Value: The current value is v1.

key
string

An API Key valid for the requested service.
Value: Your valid API Key.

locationId
integer

Id of the location.


Request headers

Optional headers

Description

Accept-Encoding

Optional. Enables response compression.
Value: gzip

Response data

Response body

For illustrative purposes the example below is neatly indented and includes all possible Response fields.

  • Actual responses are more compact and the fields present will vary based on the result type and the data available.
  • See the following Response fields documentation for more information.

When requesting JSON output, the response has the following structure:

Response body structure - JSON
1{
2  "locationId": 0,
3  "liveStatusAB": "string",
4  "liveStatusBA": "string",
5  "overlapPercentageAB": 0,
6  "overlapPercentageBA": 0,
7  "lastModifiedAt": "2020-06-03T16:43:46.949Z"
8}

Response fields

The following table describes all of the fields that can appear in a response. Fields are listed by the response section they belong to and in the order that they appear in the response.

Primary fields

Description

locationId


integer

The id of location.

liveStatusAB


string

Live Traffic status for a positive direction. See: Live Status - explanation.

liveStatusBA


string

Live Traffic status for a negative direction. See: Live Status - explanation.

overlapPercentageAB


integer

Value from 0 to 100. Describe what percentage of the location length, in positive direction, is exposed as a incident in the TomTom Live Traffic service.

overlapPercentageBA


integer

Value from 0 to 100. Describe what percentage of the location length, in negative direction, is exposed as a incident in the TomTom Live Traffic service.

lastModifiedAt


string

The date of the last status modification.

Live Status - explanation

  • ACCEPTED: The whole geometry is ACCEPTED by the Traffic Fusion System and is visible in the output.
  • PARTIALLY_ACCEPTED: The part of geometry that is ACCEPTED by the Traffic Fusion System and is visible in the output.
  • REJECTED: The whole geometry is rejected by the Traffic Fusion System and is visible in the output.
  • MATCHING_ERROR, INVALID, UNKNOWN: This should not happen; please contact movesupport@tomtom.com.
  • INITIAL, SENT: Technical statuses; the Road Event Reporter did not receive a status from the Live Traffic Fusion.
  • PENDING: The location is loaded by Live Traffic Fusion; waiting on the defined date to be published.
  • PAST_DUE: The location is no longer valid.

Response codes

The following table contains response codes signifying successful and failed requests to an API server. (Choose which response codes are used in this endpoint from the following table. Delete the ones not used, and add new ones if needed.)

Code

Meaning & possible causes

200

OK

206

Partial Content

400

Malformed request : The requested syntax is not available.

400

Bad request : Parameters out of range.

401

Unauthorized :

  • The supplied Admin Key is not valid for this Request.
  • No Admin Key is supplied.

401

Unauthorized : Configuration not found.

  • The configuration does not exist in the database.
  • The user has not registered an Admin Key.

403

Forbidden : The supplied API Key is not valid for this Request.

403

Forbidden : User can only register once.

429

Too Many Requests : The API key is over QPS (Queries per second).

500

Internal Server Error : There is a problem with the TomTom Road Event Reporter Enterprise API service.

Response headers

The following table contains response headers sent back from an API server.

Headers

Description

Access-Control-Allow-Origin

The Access-Control-Allow-Origin response header indicates whether the Response can be shared with the requesting code from the given origin.
Value: *

Connection

The Connection general header controls whether or not the network connection stays open after the current transaction finishes.
Value: keep-alive

Content-Encoding

The Content-Encoding entity header is used to compress the media-type.
Value: gzip

Content-Length

The Content-Length entity header indicates the size of the entity-body in bytes that are sent to the recipient.
Value: Content-Length

Content-Type

The Content-Type entity header is used to indicate the media type of the resource.
Value: application/json;charset=UTF-8

Date

The Date general header contains the date and time at which the message was originated.
Value: Date

Strict-Transport-Security

The HTTP Strict-Transport-Security response header (often abbreviated as HSTS) lets a web site tell browsers that it should only be accessed using HTTPS, instead of using HTTP.
Value: max-age=<expire-time>& includeSubDomains

Vary

The Vary HTTP response header determines how to match future request headers to decide whether a cached Response can be used rather than requesting a fresh one from the origin server.
Value: A comma-separated list of header names.

Tracking-ID

An identifier for the request. An unique identifier used by TomTom to identify and log a specific client request and trace it back for support purposes. It is only meant to be used for support and does not involve tracking of you or your users in any form. If the Tracking-ID header was specified, it is replicated in the response. Otherwise, it is generated automatically by the service.
Value: string