Arlo

REST Pub 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 Events 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. For Events that are repeatedly scheduled, the template whill have many associated Event instances — one for each date the Event will run.

This resource can return a collection of all available templates (useful for producing navigation lists), or the details of a specific template instance (useful for retrieving data when generating a specific page). The specification of both is covered in this article.

EventTemplate instance resource

Provides access to individual template instances by ID.

Resource URI

/{platform_name}/api/2012-02-01/pub/resources/eventtemplates/{id}

General structure

{
   "TemplateID":7,
   "Code":"CONS1",
   "Name":"Professional Consulting Skills",
   "ViewUri":"http://demo.example.org/courses/7-professional-consulting-skills",
   "RegisterInterestUri":"http://demo.example.org/register-interest?t=0&e=42567699-816c-4382-b273-68e2a22d9480",
   "AdvertisedDuration":"1 day seminar",
   "AdvertisedPresenters":[
      {
         "PresenterID":21,
         "Name":"John Rich",
         "ViewUri":"http://demo.example.org/presenters/21-john-rich"
      }
   ],
   "Categories":[
      {
         "CategoryID":57,
         "Name":"Business Skills for Business Analysts"
      },
      {
         "CategoryID":32,
         "Name":"Business Skills for Architects"
      },
      {
         "CategoryID":66,
         "Name":"Consulting Skills"
      }
   ],
   "Description":{
      "Summary":"The course covers the fundamental knowledge and skills required to be an effective consultant.",
      "ContentFields":[
         {
            "FieldName":"Description",
            "Content":{
               "ContentType":"application/xhtml",
               "Text":"<p>This course is targeted for people who are new to internal or external consulting roles or who are established in consulting but want to enhance their client-facing consulting skills.</p>"
            }
         },
         {
            "FieldName":"Learning Outcomes ",
            "Content":{
               "ContentType":"application/xhtml",
               "Text":"<p>Following the completion of this course, students will:</p>\n<ul>\n<li>Understand the role of consultants and be able to identify the qualities of a good consultant</li>\n<li>Be able to use a consulting ‘statement of work’ to effectively manage the consulting process</li>\n<li>Be more effective at communicating and working with, as well as providing excellent service to, clients</li>\n<li>Apply critical thinking skills to work through client problems.</li>\n</ul>"
            }
         },
         {
            "FieldName":"Prerequisites",
            "Content":{
               "ContentType":"application/xhtml",
               "Text":"<p>There are no prerequisites for this course.</p>"
            }
         }
      ]
   },
   "BestAdvertisedOffers":[
      {
         "OfferID":0,
         "IsDiscountOffer":false,
         "OfferAmount":{
            "CurrencyCode":"NZD",
            "AmountTaxExclusive":950.00,
            "AmountTaxInclusive":1092.50,
            "FormattedAmountTaxExclusive":"$950.00",
            "FormattedAmountTaxInclusive":"$1,092.50",
            "TaxRate":{
               "ShortName":"GST",
               "Name":"GST (15%)",
               "RatePercent":15.000
            }
         }
      }
   ]
}

Item fields

Field Description
TemplateID An integer value that uniquely identifies this resource within the platform.
Code A string representing the short code used when referring to the template, up to 32 characters long. For example, MGMT101.
Name A string representing the name of this event, up to 128 characters long.
Description A structure containing descriptive information for the template.
Structure fields
  • Summary: A string representing a short plain text one-line or one-paragraph summary of the template, suitable for display in lists and search results. If the summary is blank, this field will be omitted.
  • ContentFields: An array of DescriptionField structures with marked-up content for the template. The order of the elements in the array represents the intended order of the fields on a page.
Categories An array of structures representing leaf categories associated with this template.
Structure fields
  • CategoryID: An integer value identifing the category.
  • Name: String value with the display name of the category.
AdvertisedDuration A string representing the advertised duration of the template.
AdvertisedPresenters An array of structures representing presenters associated with this template. The order of the records in the array represents the preferred display order of presenters for the template (if there are several). If the template has no presenters, this field will be omitted.
Structure fields
  • PresenterID: An integer value identifing the presenter.
  • Name: String value with the full display name of the presenter.
  • ViewUri: String representing a URI containing information about the presenter such as their profile. This field is present only if a URL with additional information is available.
BestAdvertisedOffers An array of AdvertisedOffer structures representing the best generally available offers for the template and its events.
Tags An array of strings representing tags associated with this template. If the template has no tags, this field will be omitted.
ViewUri A string representing a URI where more information for this event can be found. This may be an Arlo page, or it may be a custom URI specified by the event organizer.
RegisterInterestUri The URL of the page where interest can be registered by individuals to run a new event at a different location and/or time. Interest submissions are recorded as Leads in the platform. This field is included only if recording of interest is enabled for the template.
RegisterPrivateInterestUri The URL of the page where interest can be registered by individuals to run an event at a private or onsite location (for internal staff training, for example). Interest submissions are recorded as Leads in the platform. This field is included only if recording of interest in running an event privately is enabled for the template.

DescriptionField fields

Field Description
FieldName The name of the field. For example, Prerequisites, Objectives, or Testimonials.
Content A structure containing marked-up text representing the text content of this field.
Structure fields
  • ContentType: String representing the content type of the description, usually application/xhtml.
  • Text: Text content of the field.

HTTP GET

Returns a representation of a template by ID, including the properties above.

Optional parameters
Parameter Description
format String representing the required response format. Only required if an Accept HTTP header is not provided. Supported values: json

NOTE: If this parameter is missing and no valid Accept header is supplied, the API will return a 406 Not Acceptable response.
callback The script function to call with response data if this call is to be executed as a jsonp request. The HTTP content type for the response will be application/javascript.
fields A list of comma-separated values representing the required fields in the response payload. Supported values (field names) are listed in the item fields section. Field names are not case sensitive. Default is TemplateID,Name
region String representing the region to use when retrieving template information. Used only in platforms that have multiple regions installed. This value influences which templates are returned, and which currencies and tax rates are used when computing available offers for that region.

Supported values are dependent on regions installed on the platform. If not specified, the default region for the platform will be used when evaluating the request.
Response

See HTTP response codes and error handling for more information on the possible responses and codes returned by this resource.

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

EventTemplates collection resource

Retrieves a list of template instances for all available venues in the platform.

Resource URI

/{platform_name}/api/2012-02-01/pub/resources/eventtemplates/

General structure

This resource returns a collection entity with a StartIndex, Count and Items collection containing venue instances.

{
   "StartIndex":0,
   "Count":20,
   "Items":[
      {
         "TemplateID":22,
         "Name":"Marketing 101",
         "Categories":[
            {
               "CategoryID":28,
               "Name":"Business"
            },
            {
               "CategoryID":26,
               "Name":"Marketing"
            },
         ],
         "AdvertisedPresenters":[
            {
               "PresenterID":10,
               "Name":"Cameron Jones",
               "ViewUri":"http://demo.example.org/presenters/10-cameron-jones"
            },
            {
               "PresenterID":40,
               "Name":"Joseph Ng",
               "ViewUri":"http://demo.example.org/presenters/40-joseph-ng"
            }
         ],
         "BestAdvertisedOffers":[
            {
               "OfferID":0,
               "IsDiscountOffer":false,
               "OfferAmount":{
                  "CurrencyCode":"NZD",
                  "AmountTaxExclusive":500.00,
                  "AmountTaxInclusive":575.00,
                  "FormattedAmountTaxExclusive":"$500.00",
                  "FormattedAmountTaxInclusive":"$575.00",
                  "TaxRate":{
                     "ShortName":"GST",
                     "Name":"GST (15%)",
                     "RatePercent":15.000
                  }
               }
            }
         ]
      },
      {
         "TemplateID":23,
         "Name":"Management 101",
         "Categories":[
            {
               "CategoryID":28,
               "Name":"Business"
            },
            {
               "CategoryID":28,
               "Name":"Management"
            },
         ],
         "AdvertisedPresenters":[
            {
               "PresenterID":10,
               "Name":"Cameron Jones",
               "ViewUri":"http://demo.example.org/presenters/10-cameron-jones"
            },
            {
               "PresenterID":40,
               "Name":"Joseph Ng",
               "ViewUri":"http://demo.example.org/presenters/40-joseph-ng"
            }
         ],
         "BestAdvertisedOffers":[
            {
               "OfferID":0,
               "IsDiscountOffer":false,
               "OfferAmount":{
                  "CurrencyCode":"NZD",
                  "AmountTaxExclusive":1900.00,
                  "AmountTaxInclusive":2185.00,
                  "FormattedAmountTaxExclusive":"$1,900.00",
                  "FormattedAmountTaxInclusive":"$2,185.00",
                  "TaxRate":{
                     "ShortName":"GST",
                     "Name":"GST (15%)",
                     "RatePercent":15.000
                  }
               }
            }
         ]
      },
      ...
   ]
}

Collection fields

Field Description
StartIndex The start index of the first item in the payload within the overall result set. Used for paging.
Count The number of items returned in the payload in the Items array. This value is different to the total number of results in the overall result set (the TotalCount field). Used in paging and represents the page size.
TotalCount The total number of results in the overall result set. This field is not included unless explicitly requested in the optional parameters.
Items An array of template instance records.

HTTP GET

Returns a collection of all venues, including the properties above.

Optional parameters
Parameter Description
format String representing the required response format. Only required if an Accept HTTP header is not provided. Supported values: json

NOTE: If this parameter is missing and no valid Accept header is supplied, the API will return a 406 Not Acceptable response.
callback The script function to call with response data if this call is to be executed as a jsonp request. The HTTP content type for the response will be application/javascript.
fields A list of comma-separated values representing the required fields for each record in the response payload. Supported values (field names) are listed in the item fields section. Field names are not case sensitive. Default is TemplateID,Name
skip The number of records to skip in the source results before returning the response payload. Used for paging. Default is 0.
top The maximum number of records to return in the response payload. Used for paging. Default is 20. The maximum supported value is 200.
includeTotalCount Boolean value determining whether an additional property (TotalCount) is included in the response respresenting the total count of matching records on the server, independent of the count of records actually returned in the response payload. Used for paging. Supported values: true, false. Default is false.
region String representing the region to use when retrieving template information. Used only in platforms that have multiple regions installed. This value influences which templates are returned, and which currencies and tax rates are used when computing available offers for that region.

Supported values are dependent on regions installed on the platform. If not specified, the default region for the platform will be used when evaluating the request.
Response

See HTTP response codes and error handling for more information on the possible responses and codes returned by this resource.

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.