External Buddy List and Show Planner
External Buddy List and Show Planner
Notified provides a portal to virtual event integration feature that enables partners and Show hosts to programmatically interact with the Buddy List and Show Planner features 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.
- Buddy List API:
https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50520&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&OpCodeList={Opcode[OpCode[…]]}&OutputFormat={X|H|T(default)}&LookupByExternalUserID={0(default)|1}&{Additional, opcode-specific parameters in name=value format…}
- Show Planner API:
https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50530&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&OpCodeList={Opcode[OpCode[…]]}&OutputFormat={X|H|T(default)}&LookupByExternalUserID={0(default)|1}&{Additional, opcode-specific parameters in name=value format…}
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!50520 for the Buddy List API and LASCmd=AI:4;F:APIUTILS!50530 for the Show Planner API. All other parameters may appear in any sequence.
OpCodes
API operations to be performed are specified in the OpCode parameter. More than one opcode may be specified, allowing the caller to perform multiple steps for each person. Opcodes are evaluated in order from left to right. Each opcode requires a different set of parameters to be supplied. Parameter values may be shared among multiple opcodes. Following is a list of valid opcodes supported by the API:
| OpCode | Description |
|---|---|
| A | Add a new buddy or show planner item. |
| D | Delete a person from the Buddy List or item from the Show Planner. |
| L | Lists the contents of the Buddy List or Show Planner. |
The specific parameters accepted and return output for each opcode are documented individually, including potential errors that may occur specific to each opcode.
Example API Call
The following example call retrieves the buddy list for the person with an external id of 99347:
https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50520&APIUserAuthCode=JX11452B&APIUserCredentials=DEMO01&OpCodeList=L&OutputFormat=X&LookupByExternalID=1&ExternalID=99347&ShowKey=1007
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:
| 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. |
| 50000 | Invalid Or Missing OpCode Specified! | Either the OpCode parameter is empty or missing. |
| 50000 | Empty Or Missing Show Key For OpCodes Specified! | One of the opcodes requires a valid ShowKey parameter and ShowKey was not supplied. |
| -10 | Invalid OpCode Specified! | The specified OpCode is invalid. |
Retrieving 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.