List current options

Service version: 1
Last edit: 2022.07.21

Purpose

This endpoint is used to list settings and statuses.

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 their values. The generic request format is as follows.

URL request format

get
Request format
https://{baseURL}/notifications/{versionNumber}/settings?key={Your_API_Key}

URL request example

get
URL request example
https://api.tomtom.com/notifications/1/settings?key={Your_API_Key}

curl command request example

get
curl command request example
curl 'https://api.tomtom.com/notifications/1/settings?key={Your_API_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 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

Response data

Response body

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

Response body - JSON
1{
2 "privacySettings": {
3 "deleteAllHistoryMessagesBefore": "ISO8601_timestamp",
4 "deleteAllHistoryMessagesBeforeStatus": "<string>"
5 }
6}

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

FieldDescription

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.

Response codes

Code

Meaning & possible causes

200

OK

400

Bad request : Key missing.

Example

Request URL

get
Request example
https://api.tomtom.com/notifications/1/settings?key={Your_API_Key}

Response body

Response body - JSON
1{
2 "privacySettings": {
3 "deleteAllHistoryMessagesBefore": "2019-07-10T12:30:00.000+00:00",
4 "deleteAllHistoryMessagesBeforeStatus": "DELETED"
5 }
6}