Arlo

REST Auth API: EventSessions

EventSession resources represent the individual days when activities for an Event run, with an associated presenter. Sessions have start and finish dates, and a SessionType property which describes whether they represent venue-based or online-based activities.

Venue-based sessions have an associated VenueDetails resource that describes the venue and room where the session will be held, and online-based (webinars) have an associated OnlineDetails resource that describes the URIs used to access the online meeting.

Sessions of advanced events with per-session registration enabled support a SessionRegistration collection which provides access to session-level registration details of attendees. Sessions associated with standard events do not support this collection.

EventSession instance resource

Resource URI

/api/2012-02-01/auth/resources/eventsessions/{SessionID}/

General structure

<EventSession>
  <SessionID>654</SessionID>
  <UniqueIdentifier>e8d3e436-765d-4e45-8c69-491ec8113482</UniqueIdentifier>
  <StartDateTime>2012-01-26T08:00:00.000+11:00</StartDateTime>
  <FinishDateTime>2012-01-26T10:00:00.000+11:00</FinishDateTime>
  <StartTimeZoneAbbr>NZDT</StartTimeZoneAbbr>
  <FinishTimeZoneAbbr>NZDT</FinishTimeZoneAbbr>
  <SessionType>Venue</SessionType>
  <Description>Session 1</Description>
  <Status>Completed</Status>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/654/"/>
  <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/eventsessions/654/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/VenueDetails" type="application/xml" title="VenueDetails" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/654/venuedetails/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Presenter" type="application/xml" title="Presenter" href="https://demo.arlo.co/api/2012-02-01/auth/resources/contacts/567/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Tags" type="application/xml" title="Tags" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/654/tags/"/>
  <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/eventsessions/654/registrations/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/RegistrationSettings" type="application/xml" title="RegistrationSettings" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/654/registrationsettings/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/RegistrationSummaryCounts" type="application/xml" title="RegistrationSummaryCounts" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/654/registrationsummarycounts/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Logistics" type="application/xml" title="Logistics" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/654/logistics/"/>
</EventSession>

Resource properties

Property Description
SessionID An integer value that uniquely identifies this resource within the platform.
UniqueIdentifier A GUID value that uniquely identifies this resource across any platform.
StartDateTime A DateTimeOffset value indicating when this session starts.
FinishDateTime A DateTimeOffset value indicating when this session finishes.
StartTimeZoneAbbr The timezone abbreviation respecting daylight savings constraints corresponding to the StartDateTime.
FinishTimeZoneAbbr The timezone abbreviation respecting daylight savings constraints corresponding to the FinishDateTime.
SessionType An EventSessionType value representing the type of this session, such as venue or online.
Description A string representing a descriptive title of this session, up to 128 characters. For example Session 4, or Field trip. For events with only one session this property is usually blank.
Status An EventSessionStatus value representing the current state of this session, such as draft, active or cancelled.
Tags Reference to a collection of text Tags associated with this session.
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
CustomFields Reference to CustomFields associated with this session.
Event Reference to the Event resource that this session is associated with.
VenueDetails Reference to an EventSessionVenueDetails resource describing the venue and room that will host this session. Used only when SessionType has the value Venue.
OnlineDetails Reference to an EventSessionOnlineDetails resource describing the online webinar details for this session. Used only when SessionType has the value Online.
Presenter Reference to a Contact resource representing the individual presenting this session.
Registrations Reference to a collection of EventSessionRegistration links representing information about contacts registered for this session. This collection is available only for session associated with advanced events supporting session-level registrations. For standard events, this collection is not available.  Note this link does not support inline expansion.
RegistrationSettings Reference to a collection of EventSessionRegistrationSettings links representing information about registration settings for this session.
RegistrationSummaryCounts Reference to a collection of EventSessionRegistrationSummaryCounts links representing information about registration summary counts for this session.
Logistics Reference to a collection of EventSessionLogistics links representing information about room setup for the sessions.

HTTP GET

Returns a representation of an EventSession, 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/eventsessions/654/

<EventSession>
  <SessionID>654</SessionID>
  <UniqueIdentifier>e8d3e436-765d-4e45-8c69-491ec8113482</UniqueIdentifier>
  <StartDateTime>2012-01-26T08:00:00.000+11:00</StartDateTime>
  <FinishDateTime>2012-01-26T10:00:00.000+11:00</FinishDateTime>
  <StartTimeZoneAbbr>NZDT</StartTimeZoneAbbr>
  <FinishTimeZoneAbbr>NZDT</FinishTimeZoneAbbr>
  <SessionType>Venue</SessionType>
  <Description>Session 1</Description>
  <Status>Completed</Status>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/654/"/>
  <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/eventsessions/654/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/VenueDetails" type="application/xml" title="VenueDetails" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/654/venuedetails/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Presenter" type="application/xml" title="Presenter" href="https://demo.arlo.co/api/2012-02-01/auth/resources/contacts/567/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Tags" type="application/xml" title="Tags" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/654/tags/"/>
  <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/eventsessions/654/registrations/"/>
</EventSession>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

EventSession collection resource

The EventSession collection resource represents the set of EventSession resources associated with all Events on the platform.

Resource URI

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

HTTP GET

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

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

<EventSessions>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventSession" type="application/xml" title="EventSession" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/1/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventSession" type="application/xml" title="EventSession" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/2/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventSession" type="application/xml" title="EventSession" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/3/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventSession" type="application/xml" title="EventSession" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/4/"/>
  ...
  <Link rel="next" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/?skip=100"/>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/"/>
</EventSessions>
Example 2

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

GET /api/2012-02-01/auth/resources/eventsessions/?expand=EventSession

<EventSessions>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventSession" type="application/xml" title="EventSession" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/1/">
    <EventSession>
      <SessionID>1</SessionID>
      <UniqueIdentifier>e8d3e436-765d-4e45-8c69-491ec8113482</UniqueIdentifier>
      <StartDateTime>2012-01-26T08:00:00.000+11:00</StartDateTime>
      <FinishDateTime>2012-01-26T10:00:00.000+11:00</FinishDateTime>
      <StartTimeZoneAbbr>NZDT</StartTimeZoneAbbr>
      <FinishTimeZoneAbbr>NZDT</FinishTimeZoneAbbr>
      <SessionType>Venue</SessionType>
      <Status>Completed</Status>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/1/"/>
      <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/eventsessions/1/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/VenueDetails" type="application/xml" title="VenueDetails" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/1/venuedetails/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Presenter" type="application/xml" title="Presenter" href="https://demo.arlo.co/api/2012-02-01/auth/resources/contacts/567/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Tags" type="application/xml" title="Tags" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/1/tags/"/>
    </EventSession>
  </Link>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventSession" type="application/xml" title="EventSession" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/2/">
    <EventSession>
      <SessionID>2</SessionID>
      <UniqueIdentifier>2fcb149f-c257-400c-a5ad-a3cd0d22676e</UniqueIdentifier>
      <StartDateTime>2012-01-27T08:00:00.000+11:00</StartDateTime>
      <FinishDateTime>2012-01-27T10:00:00.000+11:00</FinishDateTime>
      <StartTimeZoneAbbr>NZDT</StartTimeZoneAbbr>
      <FinishTimeZoneAbbr>NZDT</FinishTimeZoneAbbr>
      <SessionType>Venue</SessionType>
      <Status>Completed</Status>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/2/"/>
      <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/eventsessions/2/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/457/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/VenueDetails" type="application/xml" title="VenueDetails" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/2/venuedetails/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Presenter" type="application/xml" title="Presenter" href="https://demo.arlo.co/api/2012-02-01/auth/resources/contacts/567/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Tags" type="application/xml" title="Tags" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/2/tags/"/>
    </EventSession>
  </Link>
  ...
  <Link rel="next" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/?expand=EventSession&skip=100"/>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventsessions/?expand=EventSession"/>
</EventSessions>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.