External Show User Activity API

Notified provides a portal to virtual event integration features that enables partners and show hosts to programmatically query show user activity tracked in the Virtual Trade Show (VTS) platform, on-demand from their controlled sites and systems.

The Notified Virtual Trade Show External API also provides third-party partners the ability to programmatically automate the creation and synchronization of shared entities and attributes between their systems and the VTS database. This automation is controlled and orchestrated by the caller. The VTS platform does not currently push calls to third-party systems.

Calling The API

The API is called via a secure HTTPS request. This HTTPS request may be a GET or POST operation. Each request must supply the authentication credentials assigned to the caller by Notified. Only requests with valid credentials will be processed. These credentials identify the caller and provide access only to a specific customer area.

The format of the call is:

https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50566
&APIUserAuthCode={YourAuthCode}
&APIUserCredentials={YourCredentials}
&ShowKey={ShowKey}
&FromDateTime={FromDate in YYYY-MM-DD HH:MM:SS format}
&ToDateTime={ToDate in YYYY-MM-DD HH:MM:SS format}
&ActivityTypeFilter={filter code list, in |OPTION|OPTION| format…}
&FilterUserType={0|1|-1 where 0 = attendees, 1 = exhibitors, -1 = both}

Note: The format of the APAC Data Center is: https://api.apac.onlinexperiences.com.

Specific parameter ordering is unimportant, with the only restriction being that the first parameter MUST BE LASCmd=AI:4;F:APIUTILS!50566. All other parameters may appear in any sequence order.

Recent Activity Filtering

This API supports limiting the results to only those activities that occurred after a specified date and time. To limit results, pass a date/time value in the FromDate parameter and/or ToDate parameter in YYYY-MM-DD HH:MM:SS format.

Activity Type Filter Code List

This API supports limiting the results returned to a specific type or category, based on the ActivityTypeFilter string specified in the call. The filter codes are specified in a pipe-delimited string format (|FT|TT|XX|). If this parameter is omitted, the API defaults to ALL. Following is a list of valid opcodes supported by the API:

Example API Call

The following example call retrieves the list of booth visits and show logins for the show with the ShowKey of 99347:

https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50566&APIUserAuthCode=JX11452B&APIUserCredentials=DEMO01&ShowKey=99347&ActivityTypeFilter=|SL|BV|

Before the API begins processing the request, certain credential and parameter validations are made. If any of these top-level validations fail, an error will be returned. Below is a listing of potential top-level validation errors:

Potential Error Codes

The format of an error return is:

<?xml version="1.0" encoding="utf-8"?>

<CallFailed Status="{ErrorCode}" Diag="{ErrorDescription}" />

Retrieving Results From The API

The API returns results in XML format by default. JSON format is also supported by adding “OutputFormat=J” to the call.  The response is encoded in UTF-8 format. Attributes are used to convey values for nodes. In cases where there can be multiple nodes of a given type, a container node is used with the plural name of the contained node.

As many of the attributes contain date/time values, it is important to note that all dates and times are in Central Standard Time (CST [GMT-6]). Also, all dates are returned in the ODBC standard format of YYYY-MM-DD HH:MM:SS. Following is documentation of each node and its attributes.

Returned activity data is grouped under the ShowUser node that the activity relates to.