Download prepared data
Purpose
This endpoint requests the url to download prepared, archived data.
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 these values. The generic URL format is as follows.
URL request format
https://{baseURL}/geofencing/{versionNumber}/download/{token}?key={Your_API_Key}&adminKey={Your_Admin_Key}
curl command request format
curl 'https://{baseURL}/geofencing/{versionNumber}/download/{token}?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. |
| Token that represents the data to download. |
Response data
Response body
The following JSON code block demonstrates a successful response from the API server.
1{2 "url": "<string>"3}
Response fields
The following table describes all of the response fields.
Primary fields | Description |
---|---|
| The URL that links to the file which will include all data that should be collected with the provided token.
|
Response codes
Code | Meaning & possible causes |
---|---|
| OK: Data is ready. |
| Accepted: Data is being collected. |
| Bad request: Token not found. |
| Forbidden:
|
Example
Get an archive of the historical positions.
URL request example
https://api.tomtom.com/geofencing/1/download/6ac07430-4874-4dfb-bcbd-36a589972a7f?key={Your_API_Key}&adminKey={Your_Admin_Key}
Response body example
The file download will begin.