Arlo

REST Auth API: EventTemplates

EventTemplates are the toplevel resource that describes the shared basic content details of an event independent of dates, venues, and presenters. Templates facilitate reusability of details, which is particularly important for events that run repeatedly, such as a webinar running once every week, or a course running every quarter.

Templates are a descriptive resource only, describing names and default codes of events, core logistics information, a text summary, description and other HTML content primarily used to generate the website page for the promoting the template on the website.

Templates have a collection of related Event resources which represent scheduled instances of the template, each with their own associated dates, presenters, venues and registrations. For one-off events such as conferences, the EventTemplate will have only one a single associated Event in its collection. For Events that are repeatedly scheduled, the template's related Events collection will contain many instances — one for each date the Event will run.

EventTemplate instance resource

Resource URI

/api/2012-02-01/auth/resources/eventtemplates/{TemplateID}/

Resource properties

Property Description
TemplateID A integer value that uniquely identifies this resource within the platform.
UniqueIdentifier A GUID value that uniquely identifies this resource across any platform.
Name The string name of this template, up to 128 characters long. Usually the descriptive title of the course or event.
Code A string representing the short code used when referring to this template, up to 32 characters long. Usually the business reference code of an event, such as MGMT101.
AdvertisedDuration A string containing friendly, human-readable text to use when describing the duration of the various events that use this template, up to 32 characters long. Usually a simple value such as 2 days or 8 hours, appropriate for display on your website. Since a template may be associated with events of varying durations, this property may describe a range such as 4-6 weeks. This value is not machine-parsed and can have any format.
TemplateHosting An EventTemplateHosting value representing the hosting mode for this template.
IsPrivate A Boolean value indicating whether this template represents a privately-run event for a specific client (such as a private function or onsite training), or a public event available for general registration. Events based on private templates are not publicly promoted on the website.
DefaultEventSessionType An EventSessionType value indicating the default type of session that Events based on this template will use. This default value can be used to broadly classify templates as either online or venue-based, but it is not binding, and events based on this template may override the default and use a different type for their sessions.
Status An EventTemplateStatus value representing the current state of this template, such as active or inactive (archived).
PublishOnWebsite A Boolean value indicating whether the page for this template should be published on the website.
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
Description Reference to an EventTemplateDescription resource that contains the summary, description, and other content used to describe this template.
Logistics Reference to an EventTemplateLogistics resource describing any standard catering and room setup instructions for this template to be used as defaults for Events.
Provider Reference to an Organisation responsible for managing the event described by this template. Providers are specified when events are managed by third party partner, but still have their registrations and promotion managed by the platform.
ClientOrganisation Reference to an Organisation that this event has been privately scheduled for. Used only when IsPrivate has the value true.
Events Reference to a collection of Event links representing scheduled instances of Events using this template. Note this link does not support inline expansion.
Tags Reference to a collection of text Tags associated with this template.
AdvertisedRegions Reference to a collection of Region links representing the regions this template is advertised in (on the website).
Link (title) Description
Website Reference to an alternative representation of this resource (in HTML) at an address on the website. Note this link does not support inline expansion.

HTTP GET

Returns a representation of an event template, 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/eventtemplates/123/

<EventTemplate>
  <TemplateID>123</TemplateID>
  <UniqueIdentifier>92e49ae4-0782-73ef-4e06-af61c7ace9d7</UniqueIdentifier>
  <Name>Introduction to Management</Name>
  <Code>MGMT101</Code>
  <AdvertisedDuration>8 hours</AdvertisedDuration>
  <TemplateHosting>Standard</TemplateHosting>
  <IsPrivate>false</IsPrivate>
  <DefaultEventSessionType>Venue</DefaultEventSessionType>
  <Status>Active</Status>
  <PublishOnWebsite>true</PublishOnWebsite>
  <CreatedDateTime>2012-01-01T01:08:16.08Z</CreatedDateTime>
  <LastModifiedDateTime>2012-01-05T03:11:02.48Z</LastModifiedDateTime>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/"/>  
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Description" type="application/xml" title="Description" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/description/"/>
  <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/eventtemplates/123/logistics/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Provider" type="application/xml" title="Provider" href="https://demo.arlo.co/api/2012-02-01/auth/resources/organisations/456/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Events" type="application/xml" title="Events" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/events/"/>
  <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/eventtemplates/123/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/eventtemplates/123/advertisedregions/"/>
  <Link rel="alternate" type="text/html" title="Website" href="http://acme.example.org/events/123-introduction-to-management"/>
</EventTemplate>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

EventTemplate collection resource

The EventTemplate collection resource represents the set of EventTemplates associated with the platform.

The collection is returned as a set of Link elements which can be followed to access individual EventTemplate resources, or link expansion can be used via the expand query parameter to inline the entities with the HTTP GET response.

Resource URI

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

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:
  • TemplateID
  • UniqueIdentifier
  • Name
  • Code
  • AdvertisedDuration
  • TemplateHosting
  • IsPrivate
  • DefaultEventSessionType
  • Status
  • PublishOnWebsite
  • CreatedDateTime
  • LastModifiedDateTime
  • Provider
  • ClientOrganisation
orderby A sort expression to apply to the collection. See collection sorting. The following properties may be used in sort expressions:
  • TemplateID
  • UniqueIdentifier
  • Name
  • Code
  • AdvertisedDuration
  • TemplateHosting
  • IsPrivate
  • DefaultEventSessionType
  • PublishOnWebsite
  • 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 template links with the default parameters, and no link expansion.

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

<EventTemplates>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/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/EventTemplate" type="application/xml" title="EventTemplate" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/124/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventTemplate" type="application/xml" title="EventTemplate" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/125/"/>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventTemplate" type="application/xml" title="EventTemplate" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/126/"/>
  ...
  <Link rel="next" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/?skip=100"/>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/"/>
</EventTemplates>
Example 2

Retrieve a collection of event template links with the default parameters, with EventTemplate link expansion.

GET /api/2012-02-01/auth/resources/eventtemplates/?expand=EventTemplate

<EventTemplates>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventTemplate" type="application/xml" title="EventTemplate" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/">
    <EventTemplate>
      <TemplateID>123</TemplateID>
      <UniqueIdentifier>92e49ae4-0782-73ef-4e06-af61c7ace9d7</UniqueIdentifier>
      <Name>Introduction to Management</Name>
      <Code>MGMT101</Code>
      <AdvertisedDuration>8 hours</AdvertisedDuration>
      <TemplateHosting>Standard</TemplateHosting>
      <IsPrivate>false</IsPrivate>
      <DefaultEventSessionType>Venue</DefaultEventSessionType>
      <Status>Active</Status>
      <PublishOnWebsite>true</PublishOnWebsite>
      <CreatedDateTime>2012-01-01T01:08:16.08Z</CreatedDateTime>
      <LastModifiedDateTime>2012-01-05T03:11:02.48Z</LastModifiedDateTime>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/"/>  
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Description" type="application/xml" title="Description" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/description/"/>
      <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/eventtemplates/123/logistics/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Provider" type="application/xml" title="Provider" href="https://demo.arlo.co/api/2012-02-01/auth/resources/organisations/456/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Events" type="application/xml" title="Events" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/events/"/>
      <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/eventtemplates/123/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/eventtemplates/123/advertisedregions/"/>
      <Link rel="alternate" type="text/html" title="Website" href="http://acme.example.org/events/123-introduction-to-management"/>
    </EventTemplate>
  </Link>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/EventTemplate" type="application/xml" title="EventTemplate" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/123/">
    <EventTemplate>
      <TemplateID>124</TemplateID>
      <UniqueIdentifier>18e29fe6-2681-8fe2-7311-bea93c7afe001</UniqueIdentifier>
      <Name>Introduction to Advanced Management</Name>
      <Code>MGMT102</Code>
      <AdvertisedDuration>8 hours</AdvertisedDuration>
      <TemplateHosting>Standard</TemplateHosting>
      <IsPrivate>false</IsPrivate>
      <DefaultEventSessionType>Venue</DefaultEventSessionType>
      <Status>Active</Status>
      <PublishOnWebsite>true</PublishOnWebsite>
      <CreatedDateTime>2012-01-01T01:08:16.08Z</CreatedDateTime>
      <LastModifiedDateTime>2012-01-05T03:11:02.48Z</LastModifiedDateTime>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/124/"/>  
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Description" type="application/xml" title="Description" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/124/description/"/>
      <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/eventtemplates/124/logistics/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Provider" type="application/xml" title="Provider" href="https://demo.arlo.co/api/2012-02-01/auth/resources/organisations/456/"/>
      <Link rel="http://schemas.arlo.co/api/2012/02/auth/related/Events" type="application/xml" title="Events" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/124/events/"/>
      <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/eventtemplates/124/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/eventtemplates/124/advertisedregions/"/>
      <Link rel="alternate" type="text/html" title="Website" href="http://acme.example.org/events/124-introduction-to-advanced-management"/>
    </EventTemplate>
  </Link>
  ...
  <Link rel="next" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/?expand=EventTemplate&skip=100"/>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/eventtemplates/?expand=EventTemplate"/>
</EventTemplates>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.