REST Auth API: TimeZones

A TimeZone resource represents a world timezone. These resources are used by Event, Venue and Contact resources to help manage the display and manipulation of dates and times in the platform.

TimeZone instance resource

Resource URI

/api/2012-02-01/auth/resources/timezones/{TimeZoneID}/

Resource properties

Property	Description
TimeZoneID	A integer value that uniquely identifies this resource within the platform.
Name	A string representing the descriptive name for this timezone, up to 128 characters long.

HTTP GET

Returns a representation of a TimeZone, including the properties above.

Example

GET /api/2012-02-01/auth/resources/timezones/1/

<TimeZone>
  <TimeZoneID>1</TimeZoneID>
  <Description>(GMT+12:00) Auckland, Wellington</Description>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/timezones/1/"/>
</TimeZone>

TimeZone collection resource

The TimeZone collection resource represents the set of all TimeZones available on the platform.

Resource URI

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

Returns a representation of the collection as a set of Link elements which can be followed to access individual TimeZone resources, or link expansion can be used via the expand query parameter to inline the entities with the HTTP GET response. See querying collections for general information on handling resource collections.

Optional parameters

Parameter	Description
expand	Expression referencing Link elements to expand when generating the response. See link expansion.
filter	A filter expression to apply to the collection. See collection filters. The following properties (and link titles) may be used in filter expressions: `TimeZoneID` `Name`
orderby	A sort expression to apply to the collection. See collection sorting. The following properties may be used in sort expressions: `TimeZoneID` `Name`
skip	Returns a subset of records from the collection, starting at index N+1 specified by this parameter. The `skip` and `top` parameters are generally used for collection paging.
top	Returns a subset of records from the collection, starting at index 0 or index `skip`, and returns the first N records. The `skip` and `top` parameters are generally used for collection paging.

Example 1

Retrieve a collection of TimeZone links with the default parameters, and no link expansion.

GET /api/2012-02-01/auth/resources/timezones/

<TimeZones>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/TimeZone" type="application/xml" title="TimeZone" href="https://demo.arlo.co/api/2012-02-01/auth/resources/timezones/1/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/TimeZone" type="application/xml" title="TimeZone" href="https://demo.arlo.co/api/2012-02-01/auth/resources/timezones/2/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/TimeZone" type="application/xml" title="TimeZone" href="https://demo.arlo.co/api/2012-02-01/auth/resources/timezones/3/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/TimeZone" type="application/xml" title="TimeZone" href="https://demo.arlo.co/api/2012-02-01/auth/resources/timezones/4/"/>
  ...
  <Link rel="next" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/timezones/?skip=100"/>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/timezones/"/>
</TimeZones>

Example 2

Retrieve a collection of TimeZone links with the default parameters, with TimeZone link expansion.

GET /api/2012-02-01/auth/resources/timezones/?expand=TimeZone

<TimeZones>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/TimeZone" type="application/xml" title="TimeZone" href="https://demo.arlo.co/api/2012-02-01/auth/resources/timezones/1/">
    <TimeZone>
      <TimeZoneID>1</TimeZoneID>
      <Description>(GMT+12:00) Auckland, Wellington</Description>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/timezones/1/"/>
    </TimeZone>
  </Link>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/TimeZone" type="application/xml" title="TimeZone" href="https://demo.arlo.co/api/2012-02-01/auth/resources/timezones/2/">
    <TimeZone>
      <TimeZoneID>2</TimeZoneID>
      <Description>(GMT+09:30) Adelaide</Description>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/timezones/2/"/>
    </TimeZone>
  </Link>
  ...
  <Link rel="next" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/timezones/?expand=TimeZone&skip=100"/>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/timezones/?expand=TimeZone"/>
</TimeZones>