Arlo

REST Pub API: EventSearch

The EventSearch resource is used to query and filter future/upcoming event information with associated start and end dates, registration URLs, presenters and venues. This is a key resource used to access lists of upcoming events and their details. This resource is read-only.

By default, if no filters are provided, this endpoint returns a list of all upcoming event dates for all templates. In many cases, only a narrow subset of events are needed, such as those for a particular template, presenter, or venue. To support this, a range of filters are available that allow you to restrict results based on template, venue, presenter, category and other attributes.

To support navigation and dropdown lists, a range of facets are also supported that can be used to describe the different values of specific attributes. For example, to produce a list of event presenters with a count of their events for navigation, a facet on the Presenter field can be used. To produce a list of all states where events are running, a facet on the State field can be used.

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

Resource URI

/api/2012-02-01/pub/resources/eventsearch/

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.

{
   "TotalCount":67,
   "StartIndex":0,
   "Count":20,
   "Items":[
      {
         "EventID":9026,
         "EventTemplateID":475,
         "Name":"Introduction to Management",
         "Code":"MGMT100-024",
         "Summary":"Join us for an 'Introduction to Management', get a \u2018big picture\u2019 view of how we can help you to improve productivity and boost your management skills.",
         "Description":{
            "ContentType":"application/xhtml",
            "Text":"<p>The course covers the areas of planning, leading, organising and controlling.</p><p>Topics and themes include: ethics, rationality, strategic frameworks and international business, HRM, organisational change and innovation.</p>"
         },
         "StartDateTime":"2013-06-17T16:00:00.0000000+13:00",
         "EndDateTime":"2013-06-18T17:30:00.0000000+13:00",
         "TimeZone":"NZST",
         "TimeZoneID":1,
         "Sessions":[  
            {  
               "EventID":2993,
               "Name":"Session 1",
               "Summary":"Theory session covering basic management techniques.",
               "StartDateTime":"2015-08-07T09:00:00.0000000+10:00",
               "EndDateTime":"2015-08-07T17:00:00.0000000+10:00",
               "Presenters":[
                  {
                      "PresenterID":3324,
                      "Name":"Andrew Mechner"
                  },
                  {
                      "PresenterID":221,
                      "Name":"John Sawyer"
                  }
               ],
               "IsFull":false,
               "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
                        }
                     }
                  }
               ],
            },
            {  
               "EventID":2994,
               "Name":"Session 2",
               "Summary":"Practical session allowing you to demonstrate techniques from the first session.",
               "StartDateTime":"2015-08-08T09:00:00.0000000+10:00",
               "EndDateTime":"2015-08-08T17:00:00.0000000+10:00",
               "Presenters":[
                  {
                      "PresenterID":3324,
                      "Name":"Andrew Mechner"
                  },
                  {
                      "PresenterID":221,
                      "Name":"John Sawyer"
                  }
               ],
               "IsFull":false,
               "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
                        }
                     }
                  }
               ],
            }
         ],
         "Location":{
            "VenueID":479,
            "Name":"Wellington Central",
            "VenueName":"The Richardson Hotel",
            "VenueRoomName":"Conference Hall 2",
            "StreetLine1":"20 Acme Street"
            "Suburb":"Wellington Central",
            "City":"Wellington",
            "PostCode":"5000",
            "Country":"New Zealand",
            "PointLatitude":-12.34567,
            "PointLongitude":34.56789
            "ViewUri":"http://events.example.org/venues/479-the-richardson-hotel"
         },
         "IsFull":false,
         "PlacesRemaining":5,
         "ViewUri":"http://events.example.org/events/277-1-introduction-to-management",
         "TemplateCode":"MGMT100",
         "Presenters":[
            {
               "PresenterID":3324,
               "Name":"Andrew Mechner"
            },
            {
               "PresenterID":221,
               "Name":"John Sawyer"
            }
         ],
         "RegistrationInfo":{
            "RegisterUri":"http://events.example.org/register?sgid=f4530daa-d78a-6214-b105-4358adcd7459",
            "RegisterMessage":"Register"
         },
         "Credits":[
            {
                "Type":"PD points",
                "Value":2.50
            },
            {
                "Type":"PD hours",
                "Value":1.00
            }
         ],
         "Categories":[
            {
               "CategoryID":65,
               "Name":"Management"
               "ViewUri":"http://events.example.org/categories/65-management"
            },
            {
               "CategoryID":43,
               "Name":"Professional"
               "ViewUri":"http://events.example.org/categories/43-professional"
            }
         ],
         "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 3+ registrations",
               "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
                  }
               }
            }
         ]
      },
      ...      
   ]
}

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
EventID An integer value that uniquely identifies this resource within the platform.
EventTemplateID An integer value that identifies the template associated with this event.
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 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.
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.
StartDateTime A DateTimeOffset value indicating when this event starts.
EndDateTime A DateTimeOffset value indicating when this event ends.
TimeZoneID An integer value that identifies the time zone of this event.
TimeZone A string containing the time zone abbreviation (3-5 characters) to use when expressing the full time zone of this event, such as AEST or NZDT.
Sessions An array of structures representing session information for the event, including the name, dates, and registration availability (if applicable).
Structure fields
  • Name: String display name of the session.
  • Summary: A string representing a short plain text one-line or one-paragraph summary of the session.
  • StartDateTime: A DateTimeOffset value indicating when this session starts.
  • EndDateTime: A DateTimeOffset value indicating when this session finishes.
  • Presenters: An array of structures representing presenters associated with this event. Follows the same structure as the main Presenters field.
  • Location: A structure containing locality information for the session. Follows the same structure as the main Location field.
  • IsFull: Boolean value indicating whether the event is full (has no registration spaces available). Relevant only if the session accepts registrations.
  • AdvertisedOffers: An array offers for the session. Follows the same structure as the main AdvertisedOffers field.
Location A structure containing locality information for the event, including a display description of the location, the name and physical address of the venue, and map coordinates (if available).
Structure fields
  • IsOnline: Boolean value indicating whether this event is an online (webinar) or venue-based event. This field is omitted if false, and is present only when the value is true.
  • Name: String display value describing the locality. By default this value is often the city of the venue, but may be customised to be any string such as state or suburb. This value is suitable for use in search results and lists where a description of the event's location is required.
  • VenueID: Integer value representing the ID of the venue associated with this event. This field is omitted when IsOnline is true.
  • VenueName: String representing the name of the venue where this event will run. This field is omitted when IsOnline is true.
  • VenueRoomName: String representing the name of the room where this event will run. This field is omitted when IsOnline is true, or where no room information is available.
  • StreetLine1-StreetLine4: Strings representing the street address where this event will run. This field is omitted when IsOnline is true.
  • Suburb: String representing the suburb where this event will run. This field is omitted when IsOnline is true.
  • City: String representing the name of the city where this event will run. This field is omitted when IsOnline is true.
  • State: String representing the state where this event will run. This field is omitted when IsOnline is true.
  • PostCode: String representing the post code where this event will run. This field is omitted when IsOnline is true.
  • Country: String representing the country where this event will run. This field is omitted when IsOnline is true.
  • PointLatitude: Decimal (float) value with the map latitude coordinate where this event will run. This field is omitted when IsOnline is true, or where map coordinates are not available.
  • PointLongitude: Decimal (float) value with the map longitude coordinate where this event will run. This field is omitted when IsOnline is true, or where map coordinates are not available.
  • ViewUri: String representing URI containing information about the location or venue where this event will run. This field is present only if a URL with additional information is available.
IsFull Boolean value indicating whether the event is full (has no registration spaces available).
PlacesRemaining Integer value indicating the number of registration spaces available for the event. Note this value is often null unless administrators have specifically enabled it, and it may contain a value only when the spaces available drops below a predefined threshold such as 5 or 10 remaining spots. The purpose of this field is to promote events that are nearly full.
Categories An array of structures representing categories associated with this event's template.
Structure fields
  • CategoryID: An integer value identifing the category.
  • Name: String value with the display name of the category.
  • ViewUri: String representing a URI containing information about the category.
AdvertisedOffers An array of AdvertisedOffer structures representing all promoted offers (pricing) for the event, including base offers and discounts (if any).
SessionsDescription 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 null.
Presenters An array of structures representing presenters associated with this event. The order of the records in the array represents the preferred display order of presenters for the event (if there are several). If the event has no presenter, 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.
Notice A string with a short note to be shown with this date in lists. This field is usually reserved for special notices that apply to one date in a list but not others such as For registered members only. If the event has no value for this field, it 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.
Tags An array of strings representing tags associated with this event. If the event has no tags, this field will be omitted.
RegistrationInfo A structure containing information about registration for this event.
Structure fields
  • RegisterMessage: String value with text to be shown in any register link or button -- see notes below.
  • RegisterUri: String representing a URI where registrations for this event may be placed. If registrations are not being accepted for this event, this field will be omitted.
Important notes
  • If the RegisterUri field has a value, it should be used in conjuction with the RegisterMessage field to produce a labelled link or button.
  • If the RegisterUri field is null or missing, the RegisterMessage must still be displayed as text (not a link). In these situations, this field usually contains a custom text message to be displayed for the event such as Call us for more information. Ensure your display logic can handle displaying registration information as plain text, or as link/button.
  • It is important any code uses the RegisterMessage property for links/labels and does not assume it will always have the value "Register". The message field can contain other values such as "Join waiting list" when an event is full but the waiting list feature is enabled for the event.
Provider A structure representing information about a custom organizer managing this event. This field can have a value if Arlo is accepting registrations for an event run by an outside party who want their details promoted with the event in lists.
Structure fields
  • Name: The display name of the provider.
  • WebsiteUri: String representing a URI where more information about this provider may be found. If no more information is available, this field will be omitted.
TemplateCode A string representing the short code of the template associated with this event, up to 32 characters long.
TemplateTags An array of strings representing tags associated with this event's template. If the template has no tags, this field will be omitted.
Credits A structure describing any credits associated with this event, such as professional development hours or points. The structure supports multiple definitions (such as points and hours). Exact field names depend on those configured for the platform.
IsPrivate Boolean value indicating whether the event is private. Included only if it has the value true.
ClientOrganisation A structure representing information about the client organisation for the event. Used only if the event is private.
Structure fields
  • OrganisationID: Unique identifier of the client organisation.
  • Name: The display name of the client organisation.
ClientKeyContact A structure representing information the key contact for the client organisation for the event. Used only if the event is private.
Structure fields
  • ContactID: Unique identifier of the client contact.
  • Name: The display name of the contact.
  • Email: The email address of the contact.

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 EventID,Name,StartDateTime,ViewUri
filter A list of comma-separated filters according to the filter specification for this resource.
facets A list of comma-separated facet requests according to the facet specification for this resource.
facetsfilter A list of comma-separated filters according to the filter specification for this resource that are to be applied during facet generation.

This query parameter is specific to facet generation and is independent of the general filter. It does not affect the actual results of the API call.
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 event information. Used only in platforms that have multiple regions installed. This value influences which events 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.
timeZoneID When supplied, determines the time zone to use when rebasing the StartDateTime and EndDateTime values of online events (webinars). Rebasing involves converting times to use the UTC offset of the specified time zone.

This parameter does not affect venue-based event records (which always have offsets relative to the local time zone of their venue).

This parameter is used to allow clients to specify their preferred display time zone for browsing online events. If not specified, the default time zone of each event will be used, and no rebasing of times will occur. To create a list of time zones for users to select in your interface, use the TimeZones resource.

Filters

This resource supports use of filters specified using the filter query parameter. Multiple filters are supported and must be separated by commas.

See EventSearch filters for a list of available filter codes and their specification.

Facets

This resource supports the generation of facets that can be included in the result payload.

See EventSearch facets for a list of available facet codes and their specification.

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.