Arlo home

REST Pub API: OnlineActivitySearch

The OnlineActivitySearch resource is used to query online activity (OA) resources (c.f. self paced learning activities) information with codes, summaries, pricing, credits and content uri's. This is a key resource used to access lists of upcoming OA's and their details. This resource is read-only.

OA resources are associated with event templates in the same manner that 'traditional' events are.

By default, this endpoint returns a list of all upcoming OA objects. There are no filters supported for this endpoint at this time.

This endpoint does not support facets.

Note this resource can be used to access only online activities which are public (or published). Results do not include historical (completed), draft, or unpublished events.

Resource URI

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

General structure

This resource returns a collection entity with a StartIndex, Count, optional TotalCount (if requested) and Items collection with the results of the query.

{  
  "StartIndex":0,
  "Count":4,
  "Items":[  
    {  
      "OnlineActivityID":7,
      "Code":"SPL-OA-001",
      "Name":"SPL",
      "ExternalContentUri":"http://sp-apps.com",
      "Summary":"SPA advanced",
      "Description":{  
        "ContentType":"application/xhtml",
        "Text":"
Become an SPA wizard!
"
      },
      "AdvertisedOffers":[
        {
            "OfferID":0,
            "IsDiscountOffer":false,
            "OfferAmount":{
                "CurrencyCode":"AUD",
                "AmountTaxExclusive":2181.82,
                "AmountTaxInclusive":2400.00,
                "FormattedAmountTaxExclusive":"$2,181.82",
                "FormattedAmountTaxInclusive":"$2,400.00",
                "TaxRate":{
                    "ShortName":"GST",
                    "Name":"GST (10%)",
                    "RatePercent":10.000
                }
            }
        },
        {
            "OfferID":1,
            "IsDiscountOffer":true,
            "Label":"15% discount for members",
            "OfferAmount":{
                "CurrencyCode":"AUD",
                "AmountTaxExclusive":1854.55,
                "AmountTaxInclusive":2040.00,
                "FormattedAmountTaxExclusive":"$1,854.55",
                "FormattedAmountTaxInclusive":"$2,040.00",
                "TaxRate":{
                    "ShortName":"GST",
                    "Name":"GST (10%)",
                    "RatePercent":10.000
                }
            }
        }
      ]
    },
    {  
      "OnlineActivityID":6,
      "Code":"WERW1-OA-001",
      "Name":"VlogPlus",
      "ExternalContentUri":"http://vlog.com",
      "Summary":"Learn to vlog",
      "Description":{  
        "ContentType":"application/xhtml",
        "Text":"
Become a prolific vlogger
"
      },
      "AdvertisedOffers":[
        {
            "OfferID":0,
            "IsDiscountOffer":false,
            "OfferAmount":{
                "CurrencyCode":"AUD",
                "AmountTaxExclusive":2181.82,
                "AmountTaxInclusive":2400.00,
                "FormattedAmountTaxExclusive":"$2,181.82",
                "FormattedAmountTaxInclusive":"$2,400.00",
                "TaxRate":{
                    "ShortName":"GST",
                    "Name":"GST (10%)",
                    "RatePercent":10.000
                }
            }
        }           
      ]
    }
  ]
}

Fields

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 item records.

Item fields

Field Description
OnlineActivityID An integer value that uniquely identifies this resource within the platform.
TemplateID An integer value that identifies the template associated with this resource.
Name A string representing the name of the template associated with this event, up to 128 characters long. Field from the EventTemplate.
Code A string representing the short code used when referring to this resource, 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.
TemplateCode The root EventTemplate Template Code used to generate the Code of this resource, up to 32 characters long.
Summary A string representing a short plain text one-line or one-paragraph summary of this event, suitable for display in lists and search results. If the summary is blank, this field will be omitted. Field from the EventTemplate.
Description A structure containing marked-up text representing the description for this event used in sitations that require the event's full HTML content. This field is not suitable for display in lists and can contain arbitrary HTML including tables, lists and images. Field from the EventTemplate.

Structure fields

  • ContentType: String representing the content type of the description, usually application/xhtml.
  • Text: Text content of the description.
AdvertisedOffers An array of AdvertisedOffer structures representing all promoted offers (pricing) for the activity, including base offers and discounts (if any).
ExternalContentUri A string representing a URI where externally facing content for this event can be found.
TermsAndConditionsUri A string representing a URI where terms and conditions relating to this event can be found.
RegistrationCustomUri A string representing a URI where registrations for this OA can be created.
RegistrationMessageText An HTML string representing any special registration message requirements for this resource, of potentially 'unlimited' size.
SpecialNote A string describing any special notes for this resource, up to 128 characters long.
Credits An array of professional development objects. Each member of the array is a structure containing:.

Structure fields

  • Type: String representing the type of credit, typically PD Points or PD Hours.
  • Value: The decimal value of the accompanying credit.
TemplateTags An array of strings representing tags associated with this event's template. If the template has no tags, this field will be omitted.

HTTP GET

Returns a collection of events matching the search parameters specified.

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 Resource fields section. Field names are not case sensitive. Default is OnlineActivityID,Code,Name,ExternalContentUri,Summary and Description
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.

Filters

This resource does not support the use of filters

Facets

This resource does not support the generation of facets.

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.