REST Pub API: Timezones

The TimeZones collection resource can be used to retrieve the time zones that can be associated with events. This resource is useful if you want to provide a list of available timezones to users, allow them to select one, and use their selected timezone in the EventSearch timeZoneID parameter to rebase webinar event times to be relative to that timezone.

TimeZone instance resource

Provides access to individual time zone instances by ID. Skip to an an example request.

Resource URI

/api/2012-02-01/pub/resources/timezones/{id}

General structure

{
    "TimeZoneID":23,
    "Name":"(GMT-05:00) Eastern Time (US & Canada)",
    "TzNames":["America/Atikokan","America/Cayman","America/Detroit","America/Grand_Turk","America/Guayaquil","America/Iqaluit","America/Jamaica","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Montreal","America/Nassau","America/New_York","America/Nipigon","America/Pangnirtung","America/Port-au-Prince","America/Resolute","America/Thunder_Bay","America/Toronto"],
    "UtcOffset":-300
}

Item fields

Field	Description
TimeZoneID	An integer value that uniquely identifies this resource within the platform.
Name	A string representing the name of the name of the time zone, up to 128 characters long.
TzNames	A string array representing the Olson names of the name of the time zone
UtcOffset	The offset in minutes between this timezone and UTC. It can be a negative value. This can be useful for sorting the timezones.

HTTP GET

Returns a representation of a time zone by ID, including the properties above.

Optional parameters

Parameter	Description
format	String representing the required response format. Only required if an `Accept` HTTP header is not provided. Supported values: `json` NOTE: If this parameter is missing and no valid `Accept` header is supplied, the API will return a `406 Not Acceptable` response.
callback	The script function to call with response data if this call is to be executed as a `jsonp` request. The HTTP content type for the response will be `application/javascript`.
fields	A list of comma-separated values representing the required fields in the response payload. Supported values (field names) are listed in the item fields section. Field names are not case sensitive. Default is `TimeZoneID,Name`

Response

See HTTP response codes and error handling for more information on the possible responses and codes returned by this resource.

Example

Retrieve the details for a time zone with ID 27, including its name and ID.

GET /api/2012-02-01/pub/resources/timezones/27/?format=json&fields=TimeZoneID,Name

{
    "TimeZoneID":27,
    "Name":"(GMT-04:30) Caracas"
}

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

TimeZones collection resource

Retrieves a list of time zone instances for all available time zones in the platform.

Resource URI

/api/2012-02-01/pub/resources/timezones/

General structure

This resource returns a collection entity with a StartIndex, Count and Items collection containing time zone instances.

{
   "StartIndex":0,
   "Count":20,
   "Items":[
      {
         "TimeZoneID":11,
         "Name":"(GMT-10:00) Hawaii"
      },
      {
         "TimeZoneID":12,
         "Name":"(GMT-09:00) Alaska"
      },
      {
         "TimeZoneID":13,
         "Name":"(GMT-08:00) Baja California"
      },
      {
         "TimeZoneID":14,
         "Name":"(GMT-08:00) Pacific Time (US & Canada)"
      },
      {
         "TimeZoneID":15,
         "Name":"(GMT-07:00) Arizona"
      },
      {
         "TimeZoneID":16,
         "Name":"(GMT-07:00) Chihuahua, La Paz, Mazatlan"
      },
      ...
   ]
}

Collection fields

Field	Description
StartIndex	The start index of the first item in the payload within the overall result set. Used for paging.
Count	The number of items returned in the payload in the `Items` array. This value is different to the total number of results in the overall result set (the TotalCount field). Used in paging and represents the page size.
TotalCount	The total number of results in the overall result set. This field is not included unless explicitly requested in the optional parameters.
Items	An array of time zone instance records.

HTTP GET

Returns a collection of all time zones, including the properties above.

Optional parameters

Parameter	Description
format	String representing the required response format. Only required if an `Accept` HTTP header is not provided. Supported values: `json` NOTE: If this parameter is missing and no valid `Accept` header is supplied, the API will return a `406 Not Acceptable` response.
callback	The script function to call with response data if this call is to be executed as a `jsonp` request. The HTTP content type for the response will be `application/javascript`.
fields	A list of comma-separated values representing the required fields for each record in the response payload. Supported values (field names) are listed in the item fields section. Field names are not case sensitive. Default is `TimeZoneID,Name`
skip	The number of records to skip in the source results before returning the response payload. Used for paging. Default is `0`.
top	The maximum number of records to return in the response payload. Used for paging. Default is `20`. The maximum supported value is `200`.
includeTotalCount	Boolean value determining whether an additional property (`TotalCount`) is included in the response respresenting the total count of matching records on the server, independent of the count of records actually returned in the response payload. Used for paging. Supported values: `true`, `false`. Default is `false`.

Response

See HTTP response codes and error handling for more information on the possible responses and codes returned by this resource.

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.