Arlo

REST Auth API: Venues

Venue resources represent a physical location or facility where EventSessions can be hosted.

Venues are defined by a physical Address, an associated local TimeZone and optional Contact who may receive information about scheduled sessions with special instructions for preparing rooms and facilities.

Venue instance resource

Resource URI

/{platform_name}/api/2012-02-01/auth/resources/venues/{VenueID}/

Resource properties

Property Description
VenueID An integer value that uniquely identifies this resource within the platform.
Name A string representing the name of this venue, up to 256 characters long.
Phone A string representing the contact phone number of this Venue.
Status A VenueStatus value representing the current state of this Venue, such as active or inactive (archived).
CreatedDateTime A UTC DateTime value indicating when this resource was created.
LastModifiedDateTime A UTC DateTime value indicating when this resource was last modified.

HTTP GET

Returns a representation of a Venue, 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 /demo/api/2012-02-01/auth/resources/venues/847/

<Venue>
  <VenueID>847</VenueID>
  <Name>Acme Conference Centre</Name>
  <Phone>+64 4 393 2342</Phone>
  <Status>Active</Status>
  <CreatedDateTime>2009-06-30T03:21:20.607Z</CreatedDateTime>
  <LastModifiedDateTime>2011-11-02T02:21:22.017Z</LastModifiedDateTime>
  <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/22/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/FacilityInformation" type="application/xml" title="FacilityInformation" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/847/facilityinformation/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/PhysicalAddress" type="application/xml" title="PhysicalAddress" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/847/physicaladdress/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/BookingContact" type="application/xml" title="BookingContact" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/contacts/7045/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Rooms" type="application/xml" title="Rooms" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/847/rooms/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/TimeZone" type="application/xml" title="TimeZone" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/timezones/1/"/>
  <Link rel="alternate" type="text/html" title="Website" href="http://acme.example.org/venues/847-acme-conference-centre"/>
</Venue>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

Venue collection resource

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

Resource URI

/{platform_name}/api/2012-02-01/auth/resources/venues/

HTTP GET

Returns a representation of the collection as a set of Link elements which can be followed to access individual Venue 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:
  • VenueID
  • Name
  • Phone
  • Status
  • CreatedDateTime
  • LastModifiedDateTime
  • PhysicalAddress
  • BookingContact
  • TimeZone
orderby A sort expression to apply to the collection. See collection sorting. The following properties may be used in sort expressions:
  • VenueID
  • Name
  • Phone
  • CreatedDateTime
  • LastModifiedDateTime
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 Venue links with the default parameters, and no link expansion.

GET /demo/api/2012-02-01/auth/resources/venues/

<Venues>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/Venue" type="application/xml" title="Venue" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/847/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/Venue" type="application/xml" title="Venue" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/848/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/Venue" type="application/xml" title="Venue" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/849/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/Venue" type="application/xml" title="Venue" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/850/"/>
  ...
  <Link rel="next" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/?skip=100"/>
  <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/"/>
</Venues>
Example 2

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

GET /demo/api/2012-02-01/auth/resources/venues/?expand=Venue

<Venues>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/Venue" type="application/xml" title="Venue" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/847/">
    <Venue>
      <VenueID>847</VenueID>
      <Name>Acme Conference Centre</Name>
      <Phone>+64 4 393 2342</Phone>
      <Status>Active</Status>
      <CreatedDateTime>2009-06-30T03:21:20.607Z</CreatedDateTime>
      <LastModifiedDateTime>2011-11-02T02:21:22.017Z</LastModifiedDateTime>
      <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/847/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/FacilityInformation" type="application/xml" title="FacilityInformation" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/847/facilityinformation/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/PhysicalAddress" type="application/xml" title="PhysicalAddress" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/847/physicaladdress/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/BookingContact" type="application/xml" title="BookingContact" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/contacts/7045/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Rooms" type="application/xml" title="Rooms" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/847/rooms/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/TimeZone" type="application/xml" title="TimeZone" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/timezones/1/"/>
      <Link rel="alternate" type="text/html" title="Website" href="http://acme.example.org/venues/847-acme-conference-centre"/>
    </Venue>
  </Link>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/Venue" type="application/xml" title="Venue" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/848/">
    <Venue>
      <VenueID>848</VenueID>
      <Name>Acme Convention Tower</Name>
      <Phone>+64 9 913 3649</Phone>
      <Status>Active</Status>
      <CreatedDateTime>2010-04-10T03:20:01.502Z</CreatedDateTime>
      <LastModifiedDateTime>2011-12-01T09:19:41.139Z</LastModifiedDateTime>
      <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/848/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/FacilityInformation" type="application/xml" title="FacilityInformation" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/848/facilityinformation/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/PhysicalAddress" type="application/xml" title="PhysicalAddress" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/848/physicaladdress/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/BookingContact" type="application/xml" title="BookingContact" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/contacts/7045/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Rooms" type="application/xml" title="Rooms" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/848/rooms/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/TimeZone" type="application/xml" title="TimeZone" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/timezones/1/"/>
      <Link rel="alternate" type="text/html" title="Website" href="http://acme.example.org/venues/848-acme-convention-tower"/>
    </Venue>
  </Link>
  ...
  <Link rel="next" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/?expand=Venue&skip=100"/>
  <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/venues/?expand=Venue"/>
</Venues>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.