Clear objects position history

Service version: 1
Last edit: 2022.07.21

Purpose

This endpoint clears the history of object positions.

Request data

HTTPS method: DELETE

  • 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 format

DELETE
Request example
https://{baseURL}/locationHistory/{versionNumber}/history?key={Your_API_Key}&adminKey={Your_Admin_Key}

curl command format

DELETE
Request curl command
curl -XDELETE 'https://{baseURL}/locationHistory/{versionNumber}/history?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.

Required parametersDescription
baseURL
string
The base URL for calling the API.
Value: api.tomtom.com
versionNumber
string
Service version.
Value: 1
key
string
An API Key valid for the requested service.
Value: Your valid API Key.

Response data

Response body

Response body - JSON
1{
2 "deleteAllHistoryPositionsBefore": "ISO8601_timestamp",
3 "deleteAllHistoryPositionsBeforeStatus": "status"
4}

Response fields

The following table describes all of the fields that can appear in a response.

Primary fieldsDescription
deleteAllHistoryPositionsBefore
string
Timestamp (ISO 8601 format) marking the moment before the history will be deleted.
deleteAllHistoryPositionsBeforeStatus
string
Status of the deletion process. Live status can be checked in the current options list.
Value: PROCESSING

Response codes

CodeMeaning & possible causes
200OK: Deletion of history has begun.
403Forbidden:
  • The provided Admin Key is invalid.
  • The Admin Key is missing.

Example

Clear an object's position history

Request URL

DELETE
Request example
https://api.tomtom.com/locationHistory/1/history?key={Your_API_Key}&adminKey={Your_Admin_Key}

Response body

Response body - JSON
1{
2 "deleteAllHistoryPositionsBefore": "2019-08-12T08:32:20.843Z",
3 "deleteAllHistoryPositionsBeforeStatus": "PROCESSING"
4}