List current options

Service version: 1
Last edit: 2022.07.20

Purpose

This endpoint is used to list account and privacy 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
Request example
https://{baseURL}/geofencing/{versionNumber}settings?key={Your_API_Key}&adminKey={Your_Admin_Key}

curl command format

GET
Request curl command
curl 'https://{baseURL}/geofencing/{versionNumber}settings?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 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 "accountSettings": {
3 "maxObjects": <number>,
4 "maxFencesInProject": <number>,
5 "maxProjects": <number>,
6 "maxVerticesInFence": <number>
7 },
8 "privacySettings": {
9 "consentForStoringObjectsPositionsHistory": true/false,
10 "consentForStoringTransitionsHistory": true/false,
11 "deleteAllHistoryPositionsBefore": "ISO8601_timestamp",
12 "deleteAllHistoryPositionsBeforeStatus": "<string>",
13 "deleteAllHistoryTransitionsBefore": "ISO8601_timestamp",
14 "deleteAllHistoryTransitionsBeforeStatus": "<string>",
15 "deleteAllTransitionAlertHistoryBefore": "ISO8601_timestamp",
16 "deleteAllTransitionAlertHistoryBeforeStatus": "<string>",
17 "deleteAllDwellAlertHistoryBefore": "ISO8601_timestamp",
18 "deleteAllDwellAlertHistoryBeforeStatus": "<string>",
19 "deleteAllObjectCountAlertHistoryBefore": "ISO8601_timestamp",
20 "deleteAllObjectCountAlertHistoryBeforeStatus": "<string>",
21 "deleteAllProximityAlertHistoryBefore": "ISO8601_timestamp",
22 "deleteAllProximityAlertHistoryBeforeStatus": "<string>"
23 }
24}

Response fields

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

Primary fields
FieldDescription
accountSettings
object
A collection of account settings.
privacySettings
object
A collection of settings that consists information about privacy. By default historical data is not stored - permissions must be granted by the user.
accountSettings object
FieldDescription
maxFencesInProject
integer
Maximum number of allowed Fences in each Project.
maxObjects
integer
Maximum number of allowed Objects in a Configuration.
maxProjects
integer
Maximum number of allowed Projects in a Configuration.
maxVerticesInFence
integer
Maximum number of allowed vertices in each Fence.
privacySettings object
FieldDescription
consentForStoringObjectsPositionsHistory
boolean
Setting that allows service to store sensitive, historical data in Geofencing service. This field is shared between Geofencing and Location History API.
Value: false
consentForStoringTransitionsHistory
boolean
Setting that allows the service to store sensitive, historical data in the Geofencing service.
Value: false
deleteAllHistoryPositionsBefore
timestamp
The date before all historical data will be cleared. If there was no request for the deletion of history, this field will not be presented. This field is shared between the Geofencing and Location History API.
Value: ISO8601 timestamp
deleteAllHistoryPositionsBeforeStatus
string
The status of the process of deletion. PROCESSING means that historical data is in a processing state. DELETED informs about the end of the delete process. If there was no request for the deletion of history, this field will not be presented. This field is shared between the Geofencing and Location History API.
Value: "PROCESSING" or "DELETED"
deleteAllHistoryTransitionsBefore
timestamp
The date before all historical data will be cleared. If there was no request for the deletion of history, this field will not be presented.
Value: ISO8601 timestamp
deleteAllHistoryTransitionsBeforeStatus
string
The status of the process of deletion. PROCESSING means that historical data is in a processing state. DELETED informs about the end of the delete process. If there was no request for the deletion of history, this field will not be presented.
Value: "PROCESSING" or "DELETED"
deleteAllTransitionAlertHistoryBefore
timestamp
The date before the history of Transition Alerts will be deleted. If there was no request for the deletion of history, this field will not be presented.
Value: ISO8601 timestamp
deleteAllTransitionAlertHistoryBeforeStatus
string
The status of the Transition Alerts deletion process. PROCESSING means that historical data is in a processing state. DELETED informs about the end of the delete process. If there was no request for the deletion of history, this field will not be presented.
Value: "PROCESSING" or "DELETED"
deleteAllDwellAlertHistoryBefore
timestamp
The date before the history of Dwell Alerts will be deleted. If there was no request for the deletion of history, this field will not be presented.
Value: ISO8601 timestamp
deleteAllDwellAlertHistoryBeforeStatus
string
The status of the Dwell Alerts deletion process. PROCESSING means that historical data is in a processing state. DELETED informs about the end of the delete process. If there was no request for the deletion of history, this field will not be presented.
Value: "PROCESSING" or "DELETED"
deleteAllObjectCountAlertHistoryBefore
timestamp
The date before the history of Object Count Alerts will be deleted. If there was no request for the deletion of history, this field will not be presented.
Value: ISO8601 timestamp
deleteAllObjectCountAlertHistoryBeforeStatus
string
The status of the Object Count Alerts deletion process. PROCESSING means that historical data is in a processing state. DELETED informs about the end of the delete process. If there was no request for the deletion of history, this field will not be presented.
Value: "PROCESSING" or "DELETED"
deleteAllProximityAlertHistoryBefore
timestamp
The date before the history of Proximity Alerts will be deleted. If there was no request for the deletion of history, this field will not be presented.
Value: ISO8601 timestamp
deleteAllProximityAlertHistoryBeforeStatus
string
The status of the Proximity Alerts deletion process. PROCESSING means that historical data is in a processing state. DELETED informs about the end of the delete process. If there was no request for the deletion of history, this field will not be presented.
Value: "PROCESSING" or "DELETED"

Response codes

CodeMeaning and possible causes
200OK
400Bad request:
  • Key missing.
  • Admin Key missing.
403Forbidden:
  • Provided Admin Key is invalid.

Example

List current options

HTML Method: GET

GET
URL request example
https://api.tomtom.com/geofencing/1/settings?key={Your_API_Key}&adminKey={Your_Admin_Key}

Response body

Response body - JSON
1{
2 "accountSettings": {
3 "maxObjects": 1000,
4 "maxFencesInProject": 1000,
5 "maxProjects": 10000,
6 "maxVerticesInFence": 1000
7 },
8 "privacySettings": {
9 "consentForStoringObjectsPositionsHistory": true,
10 "consentForStoringTransitionsHistory": true,
11 "deleteAllHistoryPositionsBefore": "2020-03-10T12:45:23.851030Z",
12 "deleteAllHistoryPositionsBeforeStatus": "DELETED",
13 "deleteAllHistoryTransitionsBefore": "2020-03-10T12:45:23.851030Z",
14 "deleteAllHistoryTransitionsBeforeStatus": "DELETED",
15 "deleteAllTransitionAlertHistoryBefore": "2020-09-20T08:33:07.704937Z",
16 "deleteAllTransitionAlertHistoryBeforeStatus": "PROCESSING",
17 "deleteAllDwellAlertHistoryBefore": "2020-09-20T08:33:07.704937Z",
18 "deleteAllDwellAlertHistoryBeforeStatus": "PROCESSING",
19 "deleteAllObjectCountAlertHistoryBefore": "2020-09-20T08:33:07.704937Z",
20 "deleteAllObjectCountAlertHistoryBeforeStatus": "DELETED",
21 "deleteAllProximityAlertHistoryBefore": "2020-08-04T08:32:20.843Z",
22 "deleteAllProximityAlertHistoryBeforeStatus": "DELETED"
23 }
24}