Resource: Time Zone ( /api/timezone )

Allows the retrieval of information about a time zone.

Root Relation: TimeZone

Methods

GET


Retrieves information for a time zone.

Status Codes

These are the expected status codes returned by the service - in addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKIf then request completed successfully.
403 - ForbiddenReturned if the timezone parameter is not supplied.

Example - GET

Retrieves information for a time zone.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
idAmerica/New_YorkThe ID of the time zone (IANA time zone key, or windows timezone ID).

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

{
  "UnresolvedTimeZoneId": "America/New_York",
  "Resolved": true,
  "TimeZoneId": "Eastern Standard Time",
  "UtcOffset": "-04:00:00",
  "CurrentTimeInZone": "2013-05-28T10:04:24Z"
}

Status Code

200 - OK

  • No labels