REST Auth API: EventOptions

EventOption resources represent the individual optional extras of an Event. Options have a MultipleUnits property to determine if this unit can be consumed more than once per registration.

Options also support a collection of EventOptionRegistration which provides access to option-level registration details of Event attendees.

EventOption instance resource

Resource URI

/api/2012-02-01/auth/resources/events/{EventID}/options/{OptionID}/

General structure

<EventOption>
  <OptionID>71</OptionID>
  <MultipleUnits>false</MultipleUnits>
  <PublishOnWebsite>true</PublishOnWebsite>
  <OptionName>Option 1</OptionName>
  <OptionStatus>Active</OptionStatus>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/71/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Event" type="application/xml" title="Event" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Registrations" type="application/xml" title="Registrations" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/71/registrations/" />
</EventOption>

Resource properties

Property	Description
OptionID	An integer value that uniquely identifies this resource within the platform.
MultipleUnits	A boolean value indicating if several units of that option can be consumed during a single registration.
UnitsAvailable	An integer value representing the amount of units left if a Maximum units available is set.
PlacesRemaining	An integer value indicating the number of registration spaces available for the option. Value is relevant only if Maximum units available is set.
PublishOnWebsite	A boolean value indicating whether this option should be published on the website.
OptionName	A string representing the name of the option, up to 128 characters long.
OptionDescription	A string representing a description of the option.
OptionStatus	An EventOptionStatus value representing the current state of this option, such as Active, Cancelled or Deleted.

Link (title)	Description
Event	Reference to the Event resource that this option is associated with.
Registrations	Reference to a collection of EventOptionRegistration links representing information about contacts registered for this option. Note this link does not support inline expansion.

HTTP GET

Returns a representation of an EventOption, 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/events/456/options/72/

<EventOption>
  <OptionID>72</OptionID>
  <MultipleUnits>true</MultipleUnits>
  <UnitsAvailable>30</UnitsAvailable>
  <PlacesRemaining>0</PlacesRemaining>
  <PublishOnWebsite>true</PublishOnWebsite>
  <OptionName>Option 2</OptionName>
  <OptionStatus>Active</OptionStatus>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/72/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Event" type="application/xml" title="Event" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Registrations" type="application/xml" title="Registrations" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/72/registrations/"/>
</EventOption>

EventOption collection resource

The EventOption collection resource represents the set of EventOption resources associated with a parent Event.

Resource URI

/api/2012-02-01/auth/resources/events/{EventID}/options/

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

GET /api/2012-02-01/auth/resources/event/456/options/

<Options>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventOption" type="application/xml" title="EventOption" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/71/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventOption" type="application/xml" title="EventOption" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/72/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventOption" type="application/xml" title="EventOption" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/73/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventOption" type="application/xml" title="EventOption" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/74/" />
  ...
  <Link rel="next" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/?skip=100" />
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/" />
</Options>

Example 2

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

GET /api/2012-02-01/auth/resources/events/456/options/?expand=EventOption

<Options>
  ...
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventOption" type="application/xml" title="EventOption" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/71/">
    <EventOption>
      <OptionID>71</OptionID>
      <MultipleUnits>false</MultipleUnits>
      <PublishOnWebsite>true</PublishOnWebsite>
      <OptionName>Option 1</OptionName>
      <OptionStatus>Active</OptionStatus>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/71/" />
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Event" type="application/xml" title="Event" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/" />
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Registrations" type="application/xml" title="Registrations" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/71/registrations/" />
    </EventOption>
  </Link>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventOption" type="application/xml" title="EventOption" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/72/">
    <EventOption>
      <OptionID>72</OptionID>
      <MultipleUnits>true</MultipleUnits>
      <UnitsAvailable>30</UnitsAvailable>
      <PlacesRemaining>0</PlacesRemaining>
      <PublishOnWebsite>true</PublishOnWebsite>
      <OptionName>Option 2</OptionName>
      <OptionStatus>Active</OptionStatus>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/72/" />
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Event" type="application/xml" title="Event" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/" />
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Registrations" type="application/xml" title="Registrations" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/72/registrations/" />
    </EventOption>
  </Link>
  ...
  <Link rel="next" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/?expand=EventOption&skip=100" />
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/?expand=EventOption" />
</Options>