REST Auth API: VenueRoom

VenueRoom resources represent a location within a Venue where EventSessions can be hosted.

VenueRooms are defined by a name, an optional capacity, and a description.

VenueRoom instance resource

Resource URI

/api/2012-02-01/auth/resources/venuerooms/{VenueRoomID}/

Resource properties

Property	Description
VenueRoomID	An integer value that uniquely identifies this resource within the platform.
Name	A string representing the name of this room, up to 64 characters long.
Capacity	An integer value representing the estimated seating capacity of this room.
Status	A VenueRoomStatus value representing the current state of this resource, such as active or inactive (archived).
Description	An inline RichContent resource respresenting any private details about this room.

Link (title)	Description
Venue	Reference to a Venue resource representing the Venue this room is associated with.

HTTP GET

Returns a representation of a VenueRoom, 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/venuerooms/45/

<VenueRoom>
  <VenueRoomID>45</VenueRoomID>
  <Name>Great Northern Room</Name>
  <Capacity>90</Capacity>
  <Status>Active</Status>
  <Description>
    <ContentType>text/plain</ContentType>
    <Content>
      <![CDATA[U Shape 30
Theater 90
Classroom 40]]>
    </Content>
  </Description>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/venuerooms/45/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Venue" type="application/xml" title="Venue" href="https://demo.arlo.co/api/2012-02-01/auth/resources/venues/99/"/>
</VenueRoom>

VenueRooms collection resource

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

Resource URI

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

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

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

<VenueRooms>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/VenueRoom" type="application/xml" title="VenueRoom" href="https://demo.arlo.co/api/2012-02-01/auth/resources/venuerooms/45/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/VenueRoom" type="application/xml" title="VenueRoom" href="https://demo.arlo.co/api/2012-02-01/auth/resources/venuerooms/46/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/VenueRoom" type="application/xml" title="VenueRoom" href="https://demo.arlo.co/api/2012-02-01/auth/resources/venuerooms/47/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/VenueRoom" type="application/xml" title="VenueRoom" href="https://demo.arlo.co/api/2012-02-01/auth/resources/venuerooms/48/"/>
  ...
  <Link rel="next" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/venuerooms/?skip=100"/>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/venuerooms/"/>
</VenueRooms>

Example 2

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

GET /api/2012-02-01/auth/resources/venuerooms/?expand=VenueRoom

<VenueRooms>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/VenueRoom" type="application/xml" title="VenueRoom" href="https://demo.arlo.co/api/2012-02-01/auth/resources/venuerooms/45/">
    <VenueRoom>
      <VenueRoomID>45</VenueRoomID>
      <Name>Great Northern Room</Name>
      <Capacity>90</Capacity>
      <Status>Active</Status>
      <Description>
        <ContentType>text/plain</ContentType>
        <Content>
          <![CDATA[U Shape 30
Theater 90
Classroom 40]]>
        </Content>
      </Description>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/venuerooms/45/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Venue" type="application/xml" title="Venue" href="https://demo.arlo.co/api/2012-02-01/auth/resources/venues/99/"/>
    </VenueRoom>
  </Link>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/VenueRoom" type="application/xml" title="VenueRoom" href="https://demo.arlo.co/api/2012-02-01/auth/resources/venuerooms/46/">
    <VenueRoom>
      <VenueRoomID>46</VenueRoomID>
      <Name>Rangatiki Room</Name>
      <Capacity>8</Capacity>
      <Status>Active</Status>
      <Description>
        <ContentType>text/plain</ContentType>
        <Content>
          <![CDATA[Boardroom Style Max 8]]>
        </Content>
      </Description>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/venuerooms/46/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Venue" type="application/xml" title="Venue" href="https://demo.arlo.co/api/2012-02-01/auth/resources/venues/99/"/>
    </VenueRoom>
  </Link>
  ...
  <Link rel="next" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/venuerooms/?expand=VenueRoom&skip=100"/>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/venuerooms/?expand=VenueRoom"/>
</VenueRooms>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.