Documentation

checkDictionaries

Shows whether there are any changes in the reference lists of regions, time zones, and mobile app categories. You can also use it to get the current time on the server.

Request

Request structure in JSON format:

{
  "method": "checkDictionaries",
  "params": {
    "Timestamp
[no-highlight[

The exact time to start from to check for changes. Specified in the format YYYY-MM-DDThh:mm:ssZ (conforming to ISO 8601), such as 2015-05-24T23:59:59Z. If the method is called without the Timestamp parameter, it returns only the current time on the server.

Required

No

]no-highlight]
": (string) } }
Parameter Type Description Required
params structure (for JSON) / CheckDictionariesRequest structure (for SOAP)
Timestamp stringThe exact time to start from to check for changes. Specified in the format YYYY-MM-DDThh:mm:ssZ (conforming to ISO 8601), such as 2015-05-24T23:59:59Z. If the method is called without the Timestamp parameter, it returns only the current time on the server.No

Response

Response structure in JSON format:

{
  "result": { 
    "TimeZonesChanged
[no-highlight[

Shows whether or not there are any changes in the time zone reference list — YES/NO.

Present in the response if the Timestamp parameter was included in the method call.

]no-highlight]
": ( "YES" | "NO" ), "RegionsChanged
[no-highlight[

Shows whether or not there are any changes in the region reference list — YES/NO.

Present in the response if the Timestamp parameter was included in the method call.

]no-highlight]
": ( "YES" | "NO" ), "InterestsChanged
[no-highlight[

Shows whether or not there are any changes in the reference list of mobile app categories — YES/NO.

Present in the response if the Timestamp parameter was included in the method call.

]no-highlight]
": ( "YES" | "NO" ), "Timestamp
[no-highlight[

The exact time when the method was executed. Specified in the format YYYY-MM-DDThh:mm:ssZ (conforming to ISO 8601), such as 2015-05-24T23:59:59Z. The timestamp is specified in the next method call, to check for changes starting from this time.

]no-highlight]
": (string) /* required */ } }
Parameter Type Description
result structure (for JSON) / CheckDictionariesResponse structure (for SOAP)
TimeZonesChanged YesNoEnum

Shows whether or not there are any changes in the time zone reference list — YES/NO.

Present in the response if the Timestamp parameter was included in the method call.

RegionsChanged YesNoEnum

Shows whether or not there are any changes in the region reference list — YES/NO.

Present in the response if the Timestamp parameter was included in the method call.

InterestsChanged YesNoEnum

Shows whether or not there are any changes in the reference list of mobile app categories — YES/NO.

Present in the response if the Timestamp parameter was included in the method call.

Timestamp stringThe exact time when the method was executed. Specified in the format YYYY-MM-DDThh:mm:ssZ (conforming to ISO 8601), such as 2015-05-24T23:59:59Z. The timestamp is specified in the next method call, to check for changes starting from this time.

Examples

Request for the current server time
{
  "method": "checkDictionaries",
  "params": {}
}
Response
{
  "result": {
    "Timestamp": "2015-02-02T10:08:22Z"
  }
}
Checking for changes in the reference lists starting from 02.02.2015 10:08:22 UTC
{
  "method": "checkDictionaries",
  "params": {
    "Timestamp": "2015-02-02T10:08:22Z"
  }
}
Response
{
  "result": {
    "TimeZonesChanged": "YES",
    "RegionsChanged": "NO",
    "Timestamp": "2015-02-02T12:24:31Z"
  }
}

Changes have been made in the time zone reference list.