5.1. Return the series count and last changed timestamp of the favorites list on the server.
GET GetFavoritesStatus
Description: Returns the dataset count and timestamp of the ‘favorites’ list on the server. Normally used to check if the users favorites list has changed on the server (and may need to be downloaded again).
API Usage: This endpoint uses zero API calls. Please refer to section 8.2 for more details on API rate limits.
GET Sample Request:
GET https://[server]/GetFavoritesStatus?SessionToken=YOUR_SESSION_TOKEN
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| SessionToken | String | The Session token from the GetSessionToken endpoint. |
Response Parameters
| Parameter | Type | Mandatory | Description | |
|---|---|---|---|---|
| 1 | ServerDateTime | String | Yes | The server UTC date and time as an ISO 8601 string. |
| 2 | TimeStamp | Float | Yes | The server date and time as a Julian date. |
| 3 | ExecutionTime | Float | Yes | The number of milliseconds taken to process the request. |
| 4 | Result | [Object] | Yes | If the
request
is a success,
a Result object is
returned. See the ‘Result‘ table below for details. |
| 5 | Errors | [Object] | Yes | An 'Errors' object as described in the ‘Errors Object‘ table below. |
A successful API response will return a 'Result' object with the requested payload or an 'Errors' object detailing the issue that caused the error.
Result Object
| Parameter | Type | Mandatory | Notes |
|---|---|---|---|
| UpdatedDateTime | String | Yes | The date and time that the favorites list was last changed as an ISO 8601 string. |
| UpdatedTimeStamp | Float | Yes | The date and time that the favorites list was last changed as a Julian date. |
| SeriesCount | Integer | Yes | The number of data sets (time series) in the user favorites list. |
Errors Object
| Parameter | Type | Mandatory | Notes | |
|---|---|---|---|---|
| 1 | Status | Integer | Yes | HTTP status code. |
| 2 | Detail | String | Yes | Text description of the status code above. |
Possible Status codes in the 'Errors' object
| Code | Description |
|---|---|
| 400 | Missing parameter or unknown argument in request. |
| 404 | Unknown/expired session token. |
| 405 | Method <request> not allowed. |
| 500 | Server may be down for maintenance. |
This is not an exhaustive list and additional error codes may be returned. The Errors object Detail field will return request specific error information.
Possible HTTP response codes
This endpoint returns 200 for
success.
You can get HTTP client network errors or server
errors from any API request. You should check
with your network or IT colleagues in case the issue is
a
local one.
All server generated errors will return an
'Errors'
object that will give specific details about the error.
A full list of HTTP codes and their meanings is
available here,
Success and fail examples
The sample renews a session token using the session token string as a parameter.
Sample Request:
GET https://[server]/GetFavoritesStatus?SessionToken=YOUR_SESSION_TOKEN