External Briefcase API

Notified provides a portal to virtual event integration feature that enables partners and show hosts to programmatically interact with the User Briefcase feature of the Virtual Trade Show (VTS) platform on-demand from their controlled sites and systems.

The NotifiedVirtual Trade Show External API also provides third-party partners the ability to programmatically automate the creation and synchronization of shared data 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!50535. All other parameters may appear in any sequence.

OpCodes

API operations to be performed are specified in the OpCode parameter. Each opcode requires a different set of parameters to be supplied.

Note: The specific parameters accepted and return output for each opcode are documented individually, including potential errors may that occur to each opcode. The following example call adds a document 112358 to a particular user’s briefcase.

Example API Call

The following example call adds a document 112358 to a particular user’s briefcase:

https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50535&APIUserAuthCode=aaa&APIUserCredentials=DEbbbMO01&OpCode=A&OutputFormat=X&EMailAddress=TEST@TEST.COM&AttachmentKey=112358

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

Retrieving the results from the API

The API can return results in several formats, allowing the developer to choose what is most easily consumed. The formats are text-based, HTTP URL-encoded, and XML. Results contain a header, indicating the overall success of the call, including textual diagnostic, the number of opcodes successfully processed, and the number of opcodes that resulted in an error. Each opcode then outputs a recap section of its execution, indicating the opcode, processing result, and textual diagnostic. Error codes of 0 indicate success (no error).

In addition to the opcode recap, data elements are output for certain opcodes indicating the return values of the operation. The format of the results depends on the result format requested. For URL-encoded, these are listed as a string of HTTP parameter names and values. They are listed as a header line for text, followed by a values line, each field separated by commas. For XML, they are listed as child nodes of the opcode response. Example output is included for each opcode in the respective opcode’s documentation.