Archive historical positions

Purpose

This endpoint requests the archiving of an object's position history.

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 their values. The generic request format is as follows.

URL request format

https://{baseURL}/locationHistory/{versionNumber}/archive/positions?key={Your_API_Key}&adminKey={Your_Admin_Key}

curl command request format

curl https://{baseURL}/locationHistory/{versionNumber}/archive/positions?key={Your_API_Key}&adminKey={Your_Admin_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.
• The order of request parameters is not important.

Note: There are no optional parameters in this endpoint.

Response data

Response body

The following JSON code block demonstrates a successful response from the API server.

1{
2  "token": "<string>"
3}

Response fields

The following table describes all of the response fields.

Response codes

Example

Get archive of the historical positions.

URL request example

https://api.tomtom.com/locationHistory/1/archive/positions?key={Your_API_Key}&adminKey={Your_Admin_Key}

Response body example

1{
2  "token": "<17c4fd5c-70e0-48fb-a0d4-b9e96ee1a234>"
3}