Arlo

REST Auth API: Events

Events represent a scheduled instance of an EventTemplate resource with associated start and end dates, and a collection of Registrations representing contacts who will attend the event.

Event resources represent a logical unit for managing scheduling and registrations. Most of the key administrative tasks in managing an Event -- such as managing registrations, reporting, finances, publicity, cancellations -- will use this entity.

Events are further composed of one of more child EventSessions which describe the presenter, venue and room for individual days when activities for the event run. While Event resources represent a holistic view of an event, EventSessions represent day-specific concerns such as who will present, where, and at what time. Events that run for one day or less will always have a single session, but more complex events that span days or weeks can have many sessions of different types in different locations. For example, a course that runs once a week for 8 weeks would have 8 independent sessions, each with their own date, presenter, venue and room.

The range of dates of the child sessions are used to compute the overall StartDateTime and EndDateTime property values for the Event.

Event instance resource

Resource URI

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

General structure

<Event>
  <EventID>456</EventID>
  <UniqueIdentifier>a34fc9dc-1fa0-9019-b39a-d0fe91119ed6</UniqueIdentifier>
  <Code>MGMT101-001</Code>
  <StartDateTime>2012-02-02T09:00:00.000+12:00</StartDateTime>
  <FinishDateTime>2012-02-03T17:00:00.000+12:00</FinishDateTime>
  <StartTimeZoneAbbr>NZDT</StartTimeZoneAbbr>
  <FinishTimeZoneAbbr>NZDT</FinishTimeZoneAbbr>
  <Description>2 days, 9:00AM - 5:00PM</Description>
  <LocationName>Wellington</LocationName>
  <Status>Completed</Status>
  <CreatedDateTime>2012-01-01T04:28:00.5Z</CreatedDateTime>
  <LastModifiedDateTime>2012-01-01T09:25:05.703Z</LastModifiedDateTime>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/EventTemplate" type="application/xml" title="EventTemplate" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/"/>
  <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/events/456/logistics/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Sessions" type="application/xml" title="Sessions" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/sessions/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Options" type="application/xml" title="Options" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/"/>
  <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/events/456/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/events/456/registrationsummarycounts/"/>
  <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/registrations/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/PublicationSettings" type="application/xml" title="PublicationSettings" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/publicationsettings/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/PublicationStatus" type="application/xml" title="PublicationStatus" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/publicationstatus/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/CommunicationSettings" type="application/xml" title="CommunicationSettings" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/communicationsettings/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/TimeZone" type="application/xml" title="TimeZone" href="https://demo.arlo.co/api/2012-02-01/auth/resources/timezones/1/"/>
  <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/events/456/tags/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/AdvertisedRegions" type="application/xml" title="AdvertisedRegions" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/advertisedregions/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/PrimaryRegion" type="application/xml" title="PrimaryRegion" href="https://demo.arlo.co/api/2012-02-01/auth/resources/regions/1/"/>
  <Link rel="related" type="text/html" title="WebsiteRegister" href="http://www.example.org/register?sgid=a34fc9dc-1fa0-9019-b39a-d0fe91119ed6"/>
</Event>

Resource properties

Property Description
EventID A integer value that uniquely identifies this resource within the platform.
UniqueIdentifier A GUID value that uniquely identifies this resource across any platform.
Code A string representing the short code used when referring to this event, up to 32 characters long. By default this value is based off the EventTemplate Code with a unique integer ID appended. For example, MGMT101-001 for the first Event instance based off a template with code MGMT101.
StartDateTime A DateTimeOffset value indicating when the first (chronological) session associated with this event starts.
FinishDateTime A DateTimeOffset value indicating when the last (chronological) session associated with this event 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.
LocationName A string describing the location where this event will run, up to 256 characters long. For venue-based events, this property is defaults to the name of the city where the first session is hosted. For online-based events, this property defaults to the string Online.
Description A string describing the sessions for the Event, up to 128 characters long. This description is useful for describing the session pattern for long-running events and a default description can be generated when the Event is scheduled. For example: 9 weeks, Thu 12:00 PM – 1:30 PM describes an Event that spans nine weeks, running one session every week on Thursday afternoon for two hours. For short or single-session events, this property is usually blank.
Status An EventStatus value representing the current state of this event, such as draft, active, completed or cancelled.
ConfirmationStatus An EventConfirmationStatus value representing the current confirmation state of this event, such as waiting, confirmed or auto-confirmed. This property only applies to events that are hosted in a platform that supports confirming events.
ConfirmationDateTime A UTC DateTime value indicating when this resource was confirmed. This property only applies to events that are hosted in a platform that supports confirming events.
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
EventTemplate Reference to the EventTemplate resource that this event is based on.
KeyContact Reference to a Contact resource representing the contact responsible for managing this course within an organisation. Used only with private courses.
Logistics Reference to an EventLogistics resource containing any catering instructions for this event.
Sessions Reference to a collection of EventSession links representing the individual sessions (with venues and presenters) that compose this event. For events that run for a single day or less, this collection will contain only one session reference.
Options Reference to a collection of EventOption links representing the individual optional extras of this event.
RegistrationSettings Reference to an EventRegistrationSettings resource containing registration settings for this event.
RegistrationSummaryCounts Reference to an EventRegistrationSummaryCounts resource containing registration summary counts for this event.
Registrations Reference to a collection of Registration links representing information about contacts registered for this event.  Note this link does not support inline expansion.
PublicationSettings Reference to an EventPublicationSettings resource containing website publication settings for this event.
PublicationStatus Reference to an EventPublicationStatus resource containing information about the current publication status for this event.
CommunicationSettings Reference to an EventCommunicationSettings resource containing communication settings for this event.
TimeZone Reference to a TimeZone resource representing the timezone for this event.
Tags Reference to a collection of text Tags associated with this event.
AdvertisedRegions Reference to a collection of Region links representing the regions this event is advertised in (on the website).
PrimaryRegion Reference to a Region resource representing the primary region of this event. This link is absent if no primary region has been specified for the event.
WebsiteRegister The URL of the website register page for this event. Note this link does not support inline expansion.

HTTP GET

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

<Event>
  <EventID>456</EventID>
  <UniqueIdentifier>a34fc9dc-1fa0-9019-b39a-d0fe91119ed6</UniqueIdentifier>
  <Code>MGMT101-001</Code>
  <StartDateTime>2012-02-02T09:00:00.000+12:00</StartDateTime>
  <FinishDateTime>2012-02-03T17:00:00.000+12:00</FinishDateTime>
  <StartTimeZoneAbbr>NZDT</StartTimeZoneAbbr>
  <FinishTimeZoneAbbr>NZDT</FinishTimeZoneAbbr>
  <Description>2 days, 9:00AM - 5:00PM</Description>
  <LocationName>Wellington</LocationName>
  <Status>Completed</Status>
  <CreatedDateTime>2012-01-01T04:28:00.5Z</CreatedDateTime>
  <LastModifiedDateTime>2012-01-01T09:25:05.703Z</LastModifiedDateTime>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/EventTemplate" type="application/xml" title="EventTemplate" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/"/>
  <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/events/456/logistics/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Sessions" type="application/xml" title="Sessions" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/sessions/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Options" type="application/xml" title="Options" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/options/"/>
  <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/events/456/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/events/456/registrationsummarycounts/"/>
  <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/registrations/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/PublicationSettings" type="application/xml" title="PublicationSettings" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/publicationsettings/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/PublicationStatus" type="application/xml" title="PublicationStatus" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/publicationstatus/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/CommunicationSettings" type="application/xml" title="CommunicationSettings" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/communicationsettings/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/TimeZone" type="application/xml" title="TimeZone" href="https://demo.arlo.co/api/2012-02-01/auth/resources/timezones/1/"/>
  <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/events/456/tags/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/AdvertisedRegions" type="application/xml" title="AdvertisedRegions" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/456/advertisedregions/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/PrimaryRegion" type="application/xml" title="PrimaryRegion" href="https://demo.arlo.co/api/2012-02-01/auth/resources/regions/1/"/>
  <Link rel="related" type="text/html" title="WebsiteRegister" href="http://www.example.org/register?sgid=a34fc9dc-1fa0-9019-b39a-d0fe91119ed6"/>
</Event>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

Event collection resource

The Event collection resource represents the set of all Events associated with the platform.

Resource URI

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

HTTP GET

Returns a representation of the collection as a set of Link elements which can be followed to access individual Event 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:
  • EventID
  • UniqueIdentifier
  • Code
  • StartDateTime
  • FinishDateTime
  • LocationName
  • Status
  • CreatedDateTime
  • LastModifiedDateTime
  • KeyContact
orderby A sort expression to apply to the collection. See collection sorting. The following properties may be used in sort expressions:
  • EventID
  • UniqueIdentifier
  • Code
  • StartDateTime
  • FinishDateTime
  • LocationName
  • 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 Event links with the default parameters, and no link expansion.

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

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

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

GET /api/2012-02-01/auth/resources/events/?expand=Event

<Events>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/Event" type="application/xml" title="Event" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/1/">
    <Event>
      <EventID>1</EventID>
      <UniqueIdentifier>a34fc9dc-1fa0-9019-b39a-d0fe91119ed6</UniqueIdentifier>
      <Code>MGMT101-001</Code>
      <StartDateTime>2012-02-02T09:00:00.000+12:00</StartDateTime>
      <FinishDateTime>2012-02-03T17:00:00.000+12:00</FinishDateTime>
      <StartTimeZoneAbbr>NZDT</StartTimeZoneAbbr>
      <FinishTimeZoneAbbr>NZDT</FinishTimeZoneAbbr>
      <Description>2 days, 9:00AM - 5:00PM</Description>
      <LocationName>Wellington</LocationName>
      <Status>Completed</Status>
      <CreatedDateTime>2012-01-01T04:28:00.5Z</CreatedDateTime>
      <LastModifiedDateTime>2012-01-01T09:25:05.703Z</LastModifiedDateTime>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/1/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/EventTemplate" type="application/xml" title="EventTemplate" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/"/>
      <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/events/1/logistics/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Sessions" type="application/xml" title="Sessions" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/1/sessions/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Options" type="application/xml" title="Options" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/1/options/"/>
      <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/events/1/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/events/1/registrationsummarycounts/"/>
      <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/1/registrations/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/PublicationSettings" type="application/xml" title="PublicationSettings" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/1/publicationsettings/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/PublicationStatus" type="application/xml" title="PublicationStatus" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/1/publicationstatus/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/TimeZone" type="application/xml" title="TimeZone" href="https://demo.arlo.co/api/2012-02-01/auth/resources/timezones/1/"/>
      <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/events/1/tags/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/AdvertisedRegions" type="application/xml" title="AdvertisedRegions" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/1/advertisedregions/"/>
      <Link rel="related" type="text/html" title="WebsiteRegister" href="http://www.example.org/register?sgid=a34fc9dc-1fa0-9019-b39a-d0fe91119ed6"/>
    </Event>
  </Link>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/Event" type="application/xml" title="Event" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/2/">
    <Event>
      <EventID>2</EventID>
      <UniqueIdentifier>facfc811-1fa0-9019-b39a-d0fe91119ed6</UniqueIdentifier>
      <Code>MGMT101-002</Code>
      <StartDateTime>2013-02-02T09:45:00+12:00</StartDateTime>
      <FinishDateTime>2013-02-02T11:15:00+12:00</FinishDateTime>
      <StartTimeZoneAbbr>NZDT</StartTimeZoneAbbr>
      <FinishTimeZoneAbbr>NZDT</FinishTimeZoneAbbr>
      <LocationName>Wellington</LocationName>
      <Status>Active</Status>
      <CreatedDateTime>2012-01-01T04:28:00.5Z</CreatedDateTime>
      <LastModifiedDateTime>2012-01-01T09:25:05.703Z</LastModifiedDateTime>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/2/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/EventTemplate" type="application/xml" title="EventTemplate" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/"/>
      <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/events/2/logistics/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Sessions" type="application/xml" title="Sessions" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/2/sessions/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Options" type="application/xml" title="Options" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/2/options/"/>
      <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/events/2/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/events/2/registrationsummarycounts/"/>
      <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/2/registrations/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/PublicationSettings" type="application/xml" title="PublicationSettings" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/2/publicationsettings/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/PublicationStatus" type="application/xml" title="PublicationStatus" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/2/publicationstatus/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/TimeZone" type="application/xml" title="TimeZone" href="https://demo.arlo.co/api/2012-02-01/auth/resources/timezones/1/"/>
      <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/events/2/tags/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/AdvertisedRegions" type="application/xml" title="AdvertisedRegions" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/2/advertisedregions/"/>
      <Link rel="related" type="text/html" title="WebsiteRegister" href="http://www.example.org/register?sgid=facfc811-1fa0-9019-b39a-d0fe91119ed6"/>
    </Event>
  </Link>
  ...
  <Link rel="next" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/?expand=Event&skip=100"/>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/events/?expand=Event"/>
</Events>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.