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

List current options

 

Service version: 1
Last edit: 2020.05.21

On this page

Purpose

This endpoint is used to list settings and statuses.

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/notifications/versionNumber/settings?key=Your_Key

curl command

curl 'https://baseURL/notifications/versionNumber/settings?key=Your_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
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.

{
  "privacySettings": {
    "deleteAllHistoryMessagesBefore": "ISO8601_timestamp",
    "deleteAllHistoryMessagesBeforeStatus": "<string>"
  }
}

Response fields

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

Primary fields
Field Description
privacySettings{}
object
A collection of settings containing information about privacy.
privacySettings{} object
Field Description
deleteAllHistoryMessagesBefore
timestamp
The date before all historical message information will be cleared. If there was no request for the deletion of history, this field will not be presented.
Value: ISO8601 timestamp
deleteAllHistoryMessagesBeforeStatus
string
The status of the 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.

HTTP Response codes

Code Meaning and possible causes
200 OK
400 Bad request: Key missing.

▲ Return to top

Examples

HTML Method: GET

https://baseURL/notifications/1/settings?key=Your_API_Key

Response body

{
  "privacySettings": {
    "deleteAllHistoryMessagesBefore": "2019-07-10T12:30:00.000+00:00",
    "deleteAllHistoryMessagesBeforeStatus": "DELETED"
  }
}

▲ Return to top