External User Studio Show Registration API

Notified provides a feed to virtual event integration features that enable partners and show hosts to programmatically query the list of STUDIO events and whether a given user is registered for that event from their controlled sites and 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!50569. All other parameters may appear in any sequence order.

Show Filtering

This API supports limiting the results to only those shows that have a live or on-demand status or have a live run date on or after a specified date. Note that this API only operates on STUDIO standalone events.

Parameter Options

This API supports limiting the results returned to a specific subset as needed. The table below details the parameters that can be passed in addition to the required LASCmd, APIUserCredentials, APIUserAuthCode, and user parameters to filter and limit the results returned.

API Parameter	Type/Size	Req.	Comment
APIUserAuthCode	varchar 80	Y	Your API authorization code as supplied by Notified.
APIUserCredentials	Varchar 80	Y	Your API user credentials as supplied by Notified.
OutputFormat	Char 1	N	J for JSON or X for XML. Defaults to J.
LookupByExternalUserID	Bit (0/1)	N	Pass one (1) to look up this person by the supplied ExternalUserID (your internal identifier).
ExternalUserID	Varchar 255	N	Your internal identifier for this person. This value must be unique for each person.
EMailAddress	Varchar 255	Y	The person’s email address.
LiveStartDate	Varchar 10	N	The optional live start date filter for presentations to limit the results for. Must be specified in MM/DD/YYYY format.
LiveOnly	Bit (0/1)	N	Flag to limit results to only live presentations. Defaults to both live and on-demand.
TimeZoneInfoKey	Integer	N	Time zone specifier to return the dates and times in. See the External User API Appendix documentation for a list of valid TimeZoneInfoKey values. Defaults to UTC.

Example API Call

The following example call retrieves the list of shows and registrations for the user with the email address of Jeff@Notified.com in JSON format:

https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50569&APIUserAuthCode=JX11452B&APIUserCredentials=DEMO01&EMailAddress=Jeff@Notified.com&OutputFormat=J

Before the API begins processing the request, certain credentials 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

Error	Message	Reason
50000	Invalid API Credentials Supplied!	The credentials supplied do not match any authorized API accounts.
50000	API Access Has Been Deactivated!	The specified API account is marked inactive.
50000	API Access Not Enabled!	The API access permission has not been granted for these credentials.
50000	API Access Has Expired!	The API credentials have expired.
50000	API Access From This IP Address Not Allowed!	The API credentials do not allow calls from this IP Address.
11	User Not Found!	The user with either the specified ExternalUserID or EMailAddress could not be found.

The format of an error return is:

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

{"APIStatus":{ErrorCode},"Diag":"{ErrorDescription}","Shows":[]}

Retrieving Results From The API

The API returns results in JSON or XML format. The response is encoded in UTF-8 format. Attributes are used to convey values for XML nodes.

As some of the attributes contain date/time values, it is important to note that all dates and times are in the ODBC standard format of YYYY-MM-DD HH:MM:SS.000. Following is documentation of each attribute for the nodes returned.