Arlo

REST Auth API: EventOptionRegistrations

EventOptionRegistration resources represent a request to include a specific Option in the registration of an Event. These entities are always children connected with a parent Registration. It is possible to specify several UnitsConsumed for a single registration of that Option.

EventOptionRegistration instance resource

Resource URI

/api/2012-02-01/auth/resources/registrations/{RegistrationID}/optionregistrations/{OptionRegistrationID}/

General structure

<EventOptionRegistration>
  <RegistrationID>1401</RegistrationID>
  <UniqueIdentifier>3ccde294-b492-48ff-a29b-2c548b7d6496</UniqueIdentifier>
  <UnitsConsumed>1</UnitsConsumed>
  <Status>Approved</Status>
  <CreatedDateTime>2018-05-11T00:30:39.1553018Z</CreatedDateTime>
  <LastModifiedDateTime>2018-05-11T00:30:39.1553018Z</LastModifiedDateTime>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/registrations/4990/optionregistrations/1401/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Option" type="application/xml" title="Option" 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/ParentRegistration" type="application/xml" title="ParentRegistration" href="https://demo.arlo.co/api/2012-02-01/auth/resources/registrations/4990/" />
</EventOptionRegistration>

Resource properties

Property Description
RegistrationID An integer value that uniquely identifies this resource within the platform.
UniqueIdentifier A GUID value that uniquely identifies this resource across any platform.
UnitsConsumed An integer indicating the amount of units in use for this registration.  This will only be present if the parent option has MultipleUnits to true.
Status A RegistrationStatus value representing the current state of this registration, such as pending approval, approved, cancelled, or completed.
CreatedDateTime A UTC DateTime value indicating when this resource was created.
LastModifiedDateTime A UTC DateTime value indicating when this resource was last modified.
Link (title) Description
Option Reference to the EventOption resource this registration is for.
ParentRegistration Reference to the parent Registration that owns this instance.

HTTP GET

Returns a representation of an EventOptionRegistration, 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

Access a specific option registration that is a child of Registration with ID 4993.

GET /api/2012-02-01/auth/resources/registrations/4993/optionregistrations/1402/

<EventOptionRegistration>
  <RegistrationID>1402</RegistrationID>
  <UniqueIdentifier>e423adce-e467-473a-9ea9-32f4f50ab87a</UniqueIdentifier>
  <UnitsConsumed>9</UnitsConsumed>
  <Status>Approved</Status>
  <CreatedDateTime>2018-05-11T00:40:49.6922566Z</CreatedDateTime>
  <LastModifiedDateTime>2018-05-11T00:40:49.6922566Z</LastModifiedDateTime>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/registrations/4993/optionregistrations/1402/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Option" type="application/xml" title="Option" 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/ParentRegistration" type="application/xml" title="ParentRegistration" href="https://demo.arlo.co/api/2012-02-01/auth/resources/registrations/4993/" />
</EventOptionRegistration>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

EventOptionRegistration collection resource

The EventOptionRegistration collection resource represents a set of EventOptionRegistration resources associated with a parent entity such as a Registration or EventOption. This collection can be accessed from multiple URIs.

Resource URI

Collection resource can be accessed from a related Registration.

/api/2012-02-01/auth/resources/registrations/{RegistrationID}/optionregistrations/

Collection resource can be accessed from a related EventOption.

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

HTTP GET

Returns a representation of the collection as a set of Link elements which can be followed to access individual EventOptionRegistration 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:
  • RegistrationID
  • UniqueIdentifier
  • Status
  • CreatedDateTime
  • LastModifiedDateTime
orderby A sort expression to apply to the collection. See collection sorting. The following properties may be used in sort expressions:
  • RegistrationID
  • 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 EventOptionRegistration links associated with a particular parent registration with ID 4990 with the default parameters and no link expansion.

GET /api/2012-02-01/auth/resources/registrations/4990/optionregistrations/

<EventOptionRegistrations>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventOptionRegistration" type="application/xml" title="EventOptionRegistration" href="https://demo.arlo.co/api/2012-02-01/auth/resources/registrations/4990/optionregistrations/1400" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventOptionRegistration" type="application/xml" title="EventOptionRegistration" href="https://demo.arlo.co/api/2012-02-01/auth/resources/registrations/4990/optionregistrations/1401" />
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/registrations/4990/optionregistrations/" />
</EventOptionRegistrations>
Example 2

Retrieve a collection of EventOptionRegistration links associated with a particular option with ID 72 with the default parameters, with EventOptionRegistration and nested Option and ParentRegistration links expansion.

GET /api/2012-02-01/auth/resources/events/456/options/72/registrations?expand=EventOptionRegistration,EventOptionRegistration/Option,EventOptionRegistration/ParentRegistration

<EventOptionRegistrations>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventOptionRegistration" type="application/xml" title="EventOptionRegistration" href="https://demo.arlo.co/api/2012-02-01/auth/resources/registrations/4993/optionregistrations/1402">
    <EventOptionRegistration>
      <RegistrationID>1402</RegistrationID>
      <UniqueIdentifier>e423adce-e467-473a-9ea9-32f4f50ab87a</UniqueIdentifier>
      <UnitsConsumed>9</UnitsConsumed>
      <Status>Approved</Status>
      <CreatedDateTime>2018-05-11T00:40:49.6922566Z</CreatedDateTime>
      <LastModifiedDateTime>2018-05-11T00:40:49.6922566Z</LastModifiedDateTime>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/registrations/4993/optionregistrations/" />
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Option" type="application/xml" title="Option" 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="http://schemas.arlo.co/api/2012/02/auth/related/ParentRegistration" type="application/xml" title="ParentRegistration" href="https://demo.arlo.co/api/2012-02-01/auth/resources/registrations/4993/">
        <Registration>
          <RegistrationID>4993</RegistrationID>
          <UniqueIdentifier>7c166271-a73d-4e43-b6b5-d1bda757ced0</UniqueIdentifier>
          <Attendance>Unknown</Attendance>
          <Status>Approved</Status>
          <CreatedDateTime>2018-05-11T00:30:39.1488011Z</CreatedDateTime>
          <LastModifiedDateTime>2018-05-11T00:40:49.6922566Z</LastModifiedDateTime>
          <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/registrations/4993/" />
          <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/CustomFields" type="application/xml" title="CustomFields" href="https://demo.arlo.co/api/2012-02-01/auth/resources/registrations/4993/customfields/" />
          <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/Contact" type="application/xml" title="Contact" href="https://demo.arlo.co/api/2012-02-01/auth/resources/contacts/70/" />
          <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/SourceInfo" type="application/xml" title="SourceInfo" href="https://demo.arlo.co/api/2012-02-01/auth/resources/registrations/4993/sourceinfo/" />
          <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/SessionRegistrations" type="application/xml" title="SessionRegistrations" href="https://demo.arlo.co/api/2012-02-01/auth/resources/registrations/4993/sessionregistrations/" />
          <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/OptionRegistrations" type="application/xml" title="OptionRegistrations" href="https://demo.arlo.co/api/2012-02-01/auth/resources/registrations/4993/optionregistrations/" />
        </Registration>
      </Link>
    </EventOptionRegistration>
  </Link>
  ...
  <Link rel="next" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/72/registrations/?expand=EventOptionRegistration%2CEventOptionRegistration%2FOption%2CEventOptionRegistration%2FParentRegistration&skip=100" />
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/72/registrations/?expand=EventOptionRegistration%2CEventOptionRegistration%2FOption%2CEventOptionRegistration%2FParentRegistration" />
</EventOptionRegistrations>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.