REST Auth API: Regions

Region resources represent a geographical location used to classify EventTemplates and Events.

Regions are defined by name and a code (short name).

Region instance resource

Resource URI

/api/2012-02-01/auth/resources/regions/{RegionID}/

Resource properties

Property	Description
RegionID	An integer value that uniquely identifies this resource within the platform.
Name	A string representing the name of this region, up to 64 characters long.
ShortName	A string representing the short name or code of this region, up to 16 characters long.

HTTP GET

Returns a representation of a Region, including the properties and links above.

Optional parameters

Parameter	Description
expand	Expression referencing Link elements to expand when generating the response. See link expansion.

Example

GET /api/2012-02-01/auth/resources/regions/5/

<Region>
  <RegionID>5</RegionID>
  <Name>New Zealand</Name>
  <ShortName>NZ</ShortName>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/regions/5/"/>
</Region>

Region collection resource

The Region collection resource represents the set of Region resources on the platform.

Returns a representation of the collection as a set of Link elements which can be followed to access individual Region 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	Not supported.
orderby	Not supported.
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 Region links with the default parameters, and no link expansion.

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

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

Example 2

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

GET /api/2012-02-01/auth/resources/regions/?expand=Region

<Regions>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/Region" type="application/xml" title="Region" href="https://demo.arlo.co/api/2012-02-01/auth/resources/regions/1/">
    <Region>
      <RegionID>1</RegionID>
      <Name>New Zealand</Name>
      <ShortName>NZ</ShortName>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/regions/1/"/>
    </Region>
  </Link>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/Region" type="application/xml" title="Region" href="https://demo.arlo.co/api/2012-02-01/auth/resources/regions/2/">
    <Region>
      <RegionID>2</RegionID>
      <Name>United Kingdom</Name>
      <ShortName>UK</ShortName>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/regions/2/"/>
    </Region>
  </Link>
  ...
  <Link rel="next" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/regions/?expand=Region&skip=100"/>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/regions/?expand=Region"/>
</Regions>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.