Delete transitions history
Purpose
This endpoint is used to clear historical Transition entries.
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 request format
https://{baseURL}/geofencing/{versionNumber}/transitions?key={Your_API_Key}&adminKey={Your_Admin_Key}
curl command request format
curl -X DELETE 'https://{baseURL}/geofencing/{versionNumber}/transitions?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 parameters | Description |
---|---|
| The base URL for calling the API. |
| Service version. |
| An API Key valid for the requested service. |
| An Admin Key valid for the provided API Key. |
Response data
Response body
1{2 "deleteAllHistoryTransitionsBefore": "ISO8601_timestamp",3 "deleteAllHistoryTransitionsBeforeStatus": "status"4}
Response fields
The following table describes all of the fields that can appear in a response.
Primary fields | Description |
---|---|
| Timestamp (ISO 8601 format) marking the moment before the history will be deleted. |
| Status of the deletion process. Live status can be checked in the
current options list. |
Response codes
Code | Meaning & possible causes |
---|---|
| OK: Deletion of history has begun. |
| Forbidden:
|
Example
Clear historical Transition entries.
URL request example
https://api.tomtom.com/geofencing/1/transitions?key=PJD7y0G5AFj9Jiok6F0tIK16NiWYotb3&adminKey=FTZYUH7KxeNQohCuRvK8
Response body example
1{2 "deleteAllHistoryTransitionsBefore": "2020-07-27T08:32:20.843Z",3 "deleteAllHistoryTransitionsBeforeStatus": "PROCESSING"4}