Archive structure
Service version: 1
Last edit: 2019.10.16
On this page
- ▸ Purpose
- ▸ Request data
Purpose
This endpoint will archive projects, fences, objects, and configuration settings.
Request data
HTTPS method: GET
URL format
For ease of viewing and identification:
- Required constants and parameters are shown in bold text.
- Optional parameters are shown in plain text.
https://baseURL/geofencing/versionNumber/archive/structure?key=Your_API_Key&adminKey=Your_Admin_Key
curl command
curl 'https://baseURL/geofencing/versionNumber/archive/structure?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.
- If there is a default value that will be assumed when an optional parameter is not used, it is shown in the table.
- The order of request parameters is not important.
Required parameters | |
---|---|
Parameter | Description |
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 .
|
adminKey string |
An Admin Key valid for the provided API Key. Value: Your valid Admin Key .
|
Optional parameters | |
This endpoint does not have any optional parameters. |
Response data
Response body
The following JSON code block demonstrates a successful response from the API server.
{
"token": "<string>"
}
Response fields
The following table describes all of the response fields.
Primary fields | |
---|---|
Field | Description |
token string |
The token that will be tightly coupled with data to collect it in an asynchronous way. |
HTTP response codes
Code | Meaning & possible causes |
---|---|
200 |
OK |
403 |
Forbidden:
|
Examples
Get archive of the transitions.
Request URL GET
https://api.tomtom.com/geofencing/1/archive/structure?key=Your_API_Key&adminKey=Your_Admin_Key
Response body (JSON)
{
"token": "<17c4fd5c-70e0-48fb-a0d4-b9e96ee1a234>"
}