HTTP headers

Service version: 1
Last edit: 2022.09.01

HTTP request headers

The following table describes HTTP request headers.

Note: There are no required request headers in Geofencing API endpoints.

Optional headers

Description

Tracking-ID

Specifies 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.

  • It can be used to trace a call.
  • The value must match the regular expression '^[a-zA-Z0-9-]{1,100}$'.

  • An example of a format that matches this regular expression is UUID,


    e.g., 9ac68072-c7a4-11e8-a8d5-f2801f1b9fd1).

  • If specified, it is replicated in the Tracking-ID response header.


Value: string

HTTP response headers

The following table describes HTTP response headers.

Header

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. A 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