Sorry, you need to enable JavaScript to visit this website.

List current options

 

Service version: 1
Last edit: 2019.09.18

On this page

Purpose

This endpoint is used to list account and privacy 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/settings?key=Your_Key&adminKey=Your_Admin_Key

curl command

curl 'https://baseURL/geofencing/versionNumber/settings?key=Your_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 API Key
adminKey
string
An Admin Key valid for the provided API Key.
Value: Your valid Admin Key.
Optional parameters
Note: There are no optional parameters in this endpoint.

▲ Return to top

Response data

Response body

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

{
  "accountSettings": {
    "maxObjects": <number>,
    "maxFencesInProject": <number>,
    "maxProjects": <number>,
    "maxVerticesInFence": <number>
  },
  "privacySettings": {
    "consentForStoringObjectsPositionsHistory": true/false,
    "consentForStoringTransitionsHistory": true/false,
    "deleteAllHistoryBefore": "ISO8601_timestamp",
    "deleteAllHistoryBeforeStatus": "<string>",
    "deleteAllHistoryTransitionsBefore": "ISO8601_timestamp",
    "deleteAllHistoryTransitionsBeforeStatus": "<string>"
  }
}

Response fields

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

Primary fields
Field Description
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
Field Description
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
Field Description
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
deleteAllHistoryBefore
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
deleteAllHistoryBeforeStatus
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/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 does mean 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/DELETED

HTTP Response codes

Code Meaning and possible causes
200 OK
400 Bad request:

  • Key missing.
  • Admin Key missing.
403 Forbidden:

  • Provided Admin Key is invalid.

▲ Return to top

Examples

HTML Method: GET

https://baseURL/geofencing/1/settings?key=Your_API_Key&adminKey=Your_Admin_Key

Response body

{
  "accountSettings": {
    "maxObjects": 1000,
    "maxFencesInProject": 1000,
    "maxProjects": 10000,
    "maxVerticesInFence": 1000
  },
  "privacySettings": {
    "consentForStoringObjectsPositionsHistory": true,
    "consentForStoringTransitionsHistory": true,
    "deleteAllHistoryBefore": "2019-07-10T12:30:00.000+00:00",
    "deleteAllHistoryBeforeStatus": "DELETED",
    "deleteAllHistoryTransitionsBefore": "2019-07-10T12:45:00.000+00:00",
    "deleteAllHistoryTransitionsBeforeStatus": "PROCESSING"
  }
}

▲ Return to top

You are here