Arlo

REST Auth API: EventSessionRegistrations

EventSessionRegistration resources represent a request to attend a specific Session of an Event. These entities are always children connected with a parent Registration. Session-level registrations are supported only on advanced event types. Registrations on standard events do not generate EventSessionRegistration instances.

EventSessionRegistrations instance resource

Resource URI

Instances can be accessed as children of a related Registration.

/{platform_name}/api/2012-02-01/auth/resources/registrations/{RegistrationID}/sessionregistrations/{SessionRegistrationID}/

Instances can be accessed as children of a related EventSession.

/{platform_name}/api/2012-02-01/auth/resources/eventsessions/{EventSessionID}/registrations/{SessionRegistrationID}/

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.
Attendance A RegistrationContactAttendance value indicating whether the Contact attended the Session.
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.

HTTP GET

Returns a representation of an EventSessionRegistration, 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 session registration that is a child of Registration with ID 4993.

GET /demo/api/2012-02-01/auth/resources/registrations/4993/sessionregistrations/99232/

<EventSessionRegistration>
  <RegistrationID>99232</RegistrationID>
  <UniqueIdentifier>64109f18-8277-4cf6-ad30-7139e57a354c</UniqueIdentifier>
  <Attendance>Attended</Attendance>
  <Status>Completed</Status>
  <CreatedDateTime>2013-09-04T01:29:46.443Z</CreatedDateTime>
  <LastModifiedDateTime>2013-10-16T03:44:12.027Z</LastModifiedDateTime>
  <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/registrations/4993/sessionregistrations/99232/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Session" type="application/xml" title="Session" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventsessions/23176/"/>
  <link rel="http://schemas.arlo.co/api/2012/02/auth/related/ParentRegistration" type="application/xml" title="ParentRegistration" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/registrations/4993/" />
</EventSessionRegistration>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

Registration collection resource

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

Resource URI

Collection resource can be accessed from a related Registration.

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

Collection resource can be accessed from a related EventSession.

/{platform_name}/api/2012-02-01/auth/resources/eventsessions/{EventSessionID}/registrations/

HTTP GET

Returns a representation of the collection as a set of Link elements which can be followed to access individual EventSessionRegistration 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
  • Attendance
  • 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 EventSessionRegistration links associated with a particular session with ID 10234 with the default parameters, and no link expansion.

GET /demo/api/2012-02-01/auth/resources/eventsessions/10234/registrations/

<EventSessionRegistrations>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventSessionRegistration" type="application/xml" title="Registration" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventsessions/10234/registrations/601/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventSessionRegistration" type="application/xml" title="Registration" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventsessions/10234/registrations/602/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventSessionRegistration" type="application/xml" title="Registration" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventsessions/10234/registrations/603/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventSessionRegistration" type="application/xml" title="Registration" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventsessions/10234/registrations/604/"/>
  ...
  <Link rel="next" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventsessions/10234/registrations/?skip=100"/>
  <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventsessions/10234/registrations/"/>
</EventSessionRegistrations>
Example 2

Retrieve a collection of EventSessionRegistration links associated with a particular session with ID 10234 with the default parameters, with EventSessionRegistration link expansion.

GET /demo/api/2012-02-01/auth/resources/eventsessions/10234/registrations/?expand=EventSessionRegistration

<EventSessionRegistrations>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventSessionRegistration" type="application/xml" title="EventSessionRegistration" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventsessions/10234/registrations/601/">
    <EventSessionRegistration>
      <RegistrationID>601</RegistrationID>
      <UniqueIdentifier>730dd1df-4a0c-4660-9267-51670807b843</UniqueIdentifier>
      <Attendance>Attended</Attendance>
      <Status>Completed</Status>
      <CreatedDateTime>2011-10-28T22:42:13.95Z</CreatedDateTime>
      <LastModifiedDateTime>2011-12-23T09:25:09.483Z</LastModifiedDateTime>
      <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventsessions/10234/registrations/601/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Session" type="application/xml" title="Session" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventsessions/10234/"/>
      <link rel="http://schemas.arlo.co/api/2012/02/auth/related/ParentRegistration" type="application/xml" title="ParentRegistration" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/registrations/4993/" />
    </EventSessionRegistration>
  </Link>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventSessionRegistration" type="application/xml" title="EventSessionRegistration" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventsessions/10234/registrations/602/">
    <EventSessionRegistration>
      <RegistrationID>602</RegistrationID>
      <UniqueIdentifier>49e98cc4-717b-45e3-9144-c68b704510c0</UniqueIdentifier>
      <Attendance>Unknown</Attendance>
      <Status>Completed</Status>
      <CreatedDateTime>2011-10-29T21:12:12.35Z</CreatedDateTime>
      <LastModifiedDateTime>2011-12-25T09:45:02.143Z</LastModifiedDateTime>
      <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventsessions/10234/registrations/602/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Session" type="application/xml" title="Session" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventsessions/10234/"/>
      <link rel="http://schemas.arlo.co/api/2012/02/auth/related/ParentRegistration" type="application/xml" title="ParentRegistration" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/registrations/4994/" />
    </EventSessionRegistration>
  </Link>
  ...
  <Link rel="next" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventsessions/10234/registrations/?expand=EventSessionRegistration&skip=100"/>
  <Link rel="self" type="application/xml" href="https://api.arlo.co/demo/api/2012-02-01/auth/resources/eventsessions/10234/registrations/?expand=EventSessionRegistration"/>
</EventSessionRegistrations>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.