External SSO Deep Link Get Exhibitor API

This document provides detailed information for the External SSO Deep Link Get Exhibitor API.

Notified provides a portal to virtual event integration features that enable partners and show hosts to programmatically query show registration 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!50525. All other parameters may appear in any sequence order.

SSO Deep Link Get Exhibitor

This API supports retrieval of the Notified Exhibitor name and key that relates to the deep link currently being processed by the SSO negotiation. Note that not all deep links relate to an exhibitor entity, so return values must be checked.

Parameter Options

This API supports returning the output in one of 4 different formats, depending upon what is easiest for the caller to consume. The actual data returned is identical, just formatted differently based on the OutputFormat value.

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.
SSORequestID	Integer	Y	The SSO Request Identifier returned by the SSO initiation to retrieve deep link Exhibitor information for.
OutputFormat	Char 1	N	J for JSON, T for text, H for HTTP URL-encoded, or X for XML. Defaults to X.

Example API Call

The following example call retrieves the deep link related exhibitor information for the session with the SSORequestID of 99347 in JSON format:

https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50525&APIUserAuthCode=JX11452B&APIUserCredentials=DEMO01&SSORequestID=99347&OutputFormat=J

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

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	Invalid Show Key Specified!	The ShowKey parameter does not match any valid shows for this account.
1	Invalid Request ID	The SSORequestID parameter was not valid.
2	Opcode not related to exhibitor	The deep link does not refer to an entity related to an exhibitor.
3	Exhibitor not found	The deep link references an invalid exhibitor.

Retrieving Results From the API

The API returns the result in the requested format. The response is encoded in UTF-8 format. When requesting XML, attributes are used to convey values for nodes. Below are examples of responses in the various formats:

JSON – OutputFormat=J

{"ErrorCode":0,"ErrorDesc":"OK","ExhibitorKey":98765, "Description":"New Wave Broadcasting"}

XML – OutputFormat=X or omitted/default

HTTP URL Encoded – OutputFormat=H

ErrorCode=0&ErrorDesc=OK&ExhibitorKey=98765&Description=New Wave Broadcasting

TEXT – OutputFormat=T

ErrorCode,ErrorDesc,ExhibitorKey,Description0,"OK",98765,"New Wave Broadcasting"