REST Auth API: OnlineActivities | Arlo Training & Event Management Software

REST Auth API: Online Activities

Online activities represent an online instance of an EventTemplate resource, and a collection of Registrations representing contacts who will undertake the event.

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

Online activity instance resource

Resource URI

/api/2012-02-01/auth/resources/onlineactivities/{OnlineActivityID}/

General structure

<OnlineActivity>
  <OnlineActivityID>5</OnlineActivityID>
  <UniqueIdentifier>584d3888-9781-4d8c-9703-02606bc1c14d</UniqueIdentifier>
  <Code>EWH-OA-001</Code>
  <Name>Become an SPA wizard</Name>
  <DeliveryDescription>Complete online at your own pace (Self-paced)</DeliveryDescription>
  <ContentUri>https://www.acme.org/e-learning/resources/f7ae2045-5ac3-4d80-8f39-f84c504f87a6/</ContentUri>
  <Status>Active</Status>
  <CreatedDateTime>2014-09-15T11:33:08.159+12:00</CreatedDateTime>
  <LastModifiedDateTime>2014-09-15T11:33:08.843+12:00</LastModifiedDateTime>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/onlineactivities/5/" />
  <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/12524/" />
  <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/onlineactivities/5/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/onlineactivities/5/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/onlineactivities/5/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/onlineactivities/5/publicationsettings/"/>
  <Link rel="related" type="text/html" title="WebsiteRegister" href="http://www.example.org/register?sgid=a34fc9dc-1fa0-9019-b39a-d0fe91119ed6"/>
</OnlineActivity>

Resource properties

Property	Description
OnlineActivityID	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 activity, 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 Online Activity instance based off a template with code `MGMT101`.
Name	A string with the name for the OnlineActivity, up to 128 characters long.
DeliveryDescription	A string describing how the activity will be delivered, up to 128 characters long. This is intended to be only a summarised one-line description, suitable for display in lists. For example Watch online as a 60-minute recorded session or Delivered as 6 e-learning modules. More detailed description information describing promotional content of the activity (such as modules, prerequisites and intended audience, for example) can be found by expanding the related `EventTemplate` resource and accessing its EventTemplateDescription link.
ContentUri	A `http://` or `https://` URI referring to the content (or start point) for the online activity, up to 256 characters long. This address may be a reference to an e-learning system, a link to a video to watch, or any other website address that contains the actual content for the activity. This link will be included in messages sent to those who register for the activity.
Status	An OnlineActivityStatus value representing the current state of this resource, such as draft, active, completed or archived.
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 activity is based on.
RegistrationSettings	Reference to an OnlineActivityRegistrationSettings resource containing registration settings for this activity.
RegistrationSummaryCounts	Reference to an OnlineActivityRegistrationSummaryCounts resource containing registration summary counts for this activity.
Registrations	Reference to a collection of Registration links representing information about contacts registered for this resource. Note this link does not support inline expansion.
PublicationSettings	Reference to an OnlineActivityPublicationSettings resource containing website publication settings for this activity.
PrimaryRegion	Reference to a Region resource representing the primary region of this online activity. This link is absent if no primary region has been specified for the resource.
WebsiteRegister	The URL of the website register page for this activity. Note this link does not support inline expansion.

HTTP GET

Returns a representation of an OnlineActivity, 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/onlineactivities/7821/

<OnlineActivity>
  <OnlineActivityID>5</OnlineActivityID>
  <UniqueIdentifier>584d3888-9781-4d8c-9703-02606bc1c14d</UniqueIdentifier>
  <Code>EWH-OA-001</Code>
  <Name>Become an SPA wizard</Name>
  <DeliveryDescription>Complete online at your own pace (Self-paced)</DeliveryDescription>
  <ContentUri>https://www.acme.org/e-learning/resources/f7ae2045-5ac3-4d80-8f39-f84c504f87a6/</ContentUri>
  <Status>Active</Status>
  <CreatedDateTime>2014-09-15T11:33:08.159+12:00</CreatedDateTime>
  <LastModifiedDateTime>2014-09-15T11:33:08.843+12:00</LastModifiedDateTime>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/onlineactivities/5/" />
  <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/12524/" />
  <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/onlineactivities/5/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/onlineactivities/5/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/onlineactivities/5/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/onlineactivities/5/publicationsettings/"/>
  <Link rel="related" type="text/html" title="WebsiteRegister" href="http://www.example.org/register?sgid=a34fc9dc-1fa0-9019-b39a-d0fe91119ed6"/>
</OnlineActivity>

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

OnlineActivity collection resource

The Online Activity collection resource represents the set of all Online Activities associated with the platform.

Resource URI

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

HTTP GET

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

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

<OnlineActivities>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/OnlineActivity" type="application/xml" title="OnlineActivity" href="https://demo.arlo.co/api/2012-02-01/auth/resources/onlineactivities/3/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/OnlineActivity" type="application/xml" title="OnlineActivity" href="https://demo.arlo.co/api/2012-02-01/auth/resources/onlineactivities/4/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/OnlineActivity" type="application/xml" title="OnlineActivity" href="https://demo.arlo.co/api/2012-02-01/auth/resources/onlineactivities/5/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/OnlineActivity" type="application/xml" title="OnlineActivity" href="https://demo.arlo.co/api/2012-02-01/auth/resources/onlineactivities/6/" />
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/OnlineActivity" type="application/xml" title="OnlineActivity" href="https://demo.arlo.co/api/2012-02-01/auth/resources/onlineactivities/7/" />
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/onlineactivities/" />
</OnlineActivities>

Example 2

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

GET /api/2012-02-01/auth/resources/onlineactivities/?expand=OnlineActivity

<?xml version="1.0" encoding="UTF-8"?>
<OnlineActivities>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/OnlineActivity" type="application/xml" title="OnlineActivity" href="https://demo.arlo.co/api/2012-02-01/auth/resources/onlineactivities/3/">
    <OnlineActivity>
      <OnlineActivityID>3</OnlineActivityID>
      <UniqueIdentifier>f7ae2045-5ac3-4d80-8f39-f84c504f87a6</UniqueIdentifier>
      <Code>TB-OA-001</Code>
      <Name>Become an SPA wizard</Name>
      <DeliveryDescription>Complete online at your own pace (Self-paced)</DeliveryDescription>
      <ContentUri>https://www.acme.org/e-learning/resources/f7ae2045-5ac3-4d80-8f39-f84c504f87a6/</ContentUri>
      <Status>Active</Status>
      <CreatedDateTime>2014-09-15T11:03:08.159+12:00</CreatedDateTime>
      <LastModifiedDateTime>2014-09-15T11:21:13.803+12:00</LastModifiedDateTime>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/onlineactivities/3/" />
      <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/12514/" />
      <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/onlineactivities/3/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/onlineactivities/3/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/onlineactivities/3/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/onlineactivities/3/publicationsettings/"/>
      <Link rel="related" type="text/html" title="WebsiteRegister" href="http://www.example.org/register?sgid=f7ae2045-5ac3-4d80-8f39-f84c504f87a6"/>
    </OnlineActivity>
  </Link>
  <Link rel="http://schemas.arlo.co/api/2012/02/auth/OnlineActivity" type="application/xml" title="OnlineActivity" href="https://demo.arlo.co/api/2012-02-01/auth/resources/onlineactivities/4/">
    <OnlineActivity>
      <OnlineActivityID>4</OnlineActivityID>
      <UniqueIdentifier>5529ea65-621f-40d4-ad58-9002065559db</UniqueIdentifier>
      <Code>ANOT-OA-001</Code>
      <Name>Learn C# online</Name>
      <DeliveryDescription>Learn C# through our online series of modules!</DeliveryDescription>
      <ContentUri>http://www.acme.org/e-learning/resources/5529ea65-621f-40d4-ad58-9002065559db/</ContentUri>
      <Status>Active</Status>
      <CreatedDateTime>2014-09-15T11:03:08.159+12:00</CreatedDateTime>
      <LastModifiedDateTime>2014-09-15T11:21:13.803+12:00</LastModifiedDateTime>
      <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/onlineactivities/4/" />
      <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/12518/" />
      <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/onlineactivities/4/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/onlineactivities/4/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/onlineactivities/4/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/onlineactivities/4/publicationsettings/"/>
      <Link rel="related" type="text/html" title="WebsiteRegister" href="http://www.example.org/register?sgid=5529ea65-621f-40d4-ad58-9002065559db"/>
    </OnlineActivity>
  </Link>
  <Link rel="self" type="application/xml" href="https://demo.arlo.co/api/2012-02-01/auth/resources/onlineactivities/?expand=onlineactivity" />
</OnlineActivities>