Archive structure

Service version: 1
Last edit: 2022.07.20

Purpose

This endpoint will archive projects, fences, objects, and configuration settings.

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 format

GET
URL request example
https://{baseURL}/geofencing/{versionNumber}/archive/structure?key={Your_API_Key}&adminKey={Your_Admin_Key}

curl command format

GET
Request curl command example
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.
  • 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.
adminKey
string
An Admin Key valid for the provided API Key.
Value: Your valid Admin Key.

Response data

Response body

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

Response body - JSON
1{
2 "token": "<string>"
3}

Response fields

The following table describes all of the response fields.

Primary fieldsDescription
token
string
The token that will be tightly coupled with data to collect it in an asynchronous way.

Response codes

CodeMeaning & possible causes
200OK
403Forbidden:
  • Provided Admin Key is invalid.
  • Admin Key missing.

Example

Get an archive of the transitions.

Request URL

GET
Request example
https://api.tomtom.com/geofencing/1/archive/structure?key={Your_API_Key}&adminKey={Your_Admin_Key}

Response body

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