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/locationHistory/versionNumber/settings?key=Your_Key&adminKey=Your_Admin_Key

curl command

curl 'https://baseURL/locationHistory/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.

▲ Return to top

Response data

Response body

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

{
  "accountSettings": {
    "maxObjects": <number>
  },
  "privacySettings": {
    "consentForStoringObjectsPositionsHistory": true/false,
    "deleteAllHistoryBefore": "ISO8601_timestamp",
    "deleteAllHistoryBeforeStatus": "<string>"
  }
}

Response fields

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

HTTP Response codes

▲ Return to top

Examples

HTML Method: GET

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

Response body

{
  "accountSettings": {
    "maxObjects": 1000
  },
  "privacySettings": {
    "consentForStoringObjectsPositionsHistory": true,
    "deleteAllHistoryBefore": "2019-07-10T12:30:00.000+00:00",
    "deleteAllHistoryBeforeStatus": "DELETED"
  }
}

▲ Return to top