Set new settings values

Service version: 1
Last edit: 2022.09.01

Purpose

This endpoint is used to change privacy settings.

Request data

HTTPS method: POST

  • 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}/settings?key={Your_API_Key}&adminKey={Your_Admin_Key}

curl command request format

1curl -XPOST "Content-type: application/json" -d
2'{
3 "consentForStoringObjectsPositionsHistory": true/false,
4 "consentForStoringTransitionsHistory": true/false
5 }'
6'https://{baseURL}/geofencing/{versionNumber}/settings?key={Your_API_Key}&adminKey={Your_Admin_Key}'

POST request body format

1{
2 "consentForStoringObjectsPositionsHistory": true/false,
3 "consentForStoringTransitionsHistory": true/false
4}

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

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.

1{
2 "consentForStoringObjectsPositionsHistory": true/false,
3 "consentForStoringTransitionsHistory": true/false
4}

Response fields

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

Primary fields

Description

consentForStoringObjectsPositionsHistory
boolean

Setting that allows the service to store sensitive, historical objects data in the Geofencing service. This field is shared between the Geofencing and Location History APIs.

consentForStoringTransitionsHistory
boolean

Setting that allows the service to store sensitive, historical data in the Geofencing service.

Response codes

Code

Meaning & possible causes

200

OK

400

Bad Request: No setting has been provided.

403

Forbidden:

  • Provided Admin Key is invalid.
  • Admin Key missing.

Example

Set new setting values.

HTML Method: POST

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

POST request body example

1{
2 "consentForStoringObjectsPositionsHistory": true,
3 "consentForStoringTransitionsHistory": false
4}

Response body example

1{
2 "consentForStoringObjectsPositionsHistory": true,
3 "consentForStoringTransitionsHistory": false
4}