Set new settings values
Service version: 1
Last edit: 2019.09.18
On this page
Purpose
This endpoint is used to change privacy settings.
Request data
HTTPS method: POST
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/locationHistory/versionNumber/settings?key=Your_Key&adminKey=Your_Admin_Key
curl command
curl -XPOST "Content-type: application/json" -d
'{
"consentForStoringObjectsPositionsHistory": true/false
}'
'https://baseURL/locationHistory/versionNumber/settings?key=Your_Key&adminKey=Your_Admin_Key'
POST Request body
{
"consentForStoringObjectsPositionsHistory": true/false
}
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. |
Response data
Response body
The following JSON code block demonstrates a successful Response from the API server.
{
"consentForStoringObjectsPositionsHistory": true/false
}
Response fields
The following table describes all of the fields that can appear in a Response.
Primary fields | |
---|---|
Field | 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. |
HTTP Response codes
Code | Meaning and possible causes |
---|---|
200 |
OK |
400 |
Bad Request: No setting has been provided. |
403 |
Forbidden:
|
Examples
HTML Method: POST
https://baseURL/locationHistory/1/settings?key=Your_API_Key&adminKey=Your_Admin_Key
POST Request body (JSON)
{
"consentForStoringObjectsPositionsHistory": true
}
Response body
{
"consentForStoringObjectsPositionsHistory": true
}