External User API
External User API
Notified provides a portal to virtual event integration feature that enables partners and show hosts to launch the Virtual Trade Show (VTS)platform on-demand using single sign-on and password controls through their controlled sites and systems. The visitor only needs to log in once at the host site. Their login information is then automatically sent to the virtual event.
Several different VTS modules may be launched, including the Show module, the Remote Profile Update, the Booth Builder, and the Show Data Portal. This allows partners to fully integrate the VTS platform as a module of their site systems.
The Notified Virtual Trade Show External API also provides third-party partners the ability to programmatically automate the creation and synchronization of shared users and user 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!50500. 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 |
|---|---|
| I | Insert a new Show User. |
| U | Update an existing Show User. |
| C | Update Show User, automatically creating them if they do not exist. |
| D | Delete a Show User. |
| E | Check if a Show User exists in the system. |
| G | Retrieve a Show User’s profile information. |
| R | Register a Show User for a show with a specific Show Package. |
| r | Register a Show User for a show with a specific Show Package, updating any existing registration information. |
| K | Get User Registration Package information. |
| A | Get User Registration Add-On information. |
| F | Retrieve the list of available shows. |
| T | Create a Login Ticket token that is valid for one (1) minute, allowing for redirected logins without sending API credentials to the client browser. |
| V | Add credential badges to the given user. |
| O | Remove credential badges from the given user. |
| W | Set credential badges to a specified list of badges for the given user. |
| M | Add a list of AddOn item keys to the registration for the given user. |
| N | Remove a list of AddOn item keys from the registration for the given user. |
| H | Retrieve the list of Attendee Types. |
| J | Add an Attendee Type. |
| @ | Forget User (EU Compliance). |
| X | Retrieve the External API failure log. |
Example API Call
The following example call retrieves the profile information for the person with an external id of 99347:
https://api.onlinexperience.com/scripts/Server.nxp?LASCm d=AI:4;F:APIUTILS!50500&APIUserAuthCode=JX11452B&APIUserCredentials=DEMO01&OpCodeList=G&OutputFormat=X&LookupByExternalUserID1&ExternalUserID=99347
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 | 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 | Empty Or Missing OpCode(s) Specified! | Either the OpCode parameter is empty or missing. |
| 50000 | Empty or Missing ShowKey For OpCodes Specified! | One of the Opcodes requires a valid ShowKey parameter and ShowKey was not supplied. |
| 50000 | Invalid or Missing Show Package Key For Registration OpCode@ | The Registration OpCode was specified, but the ShowPackageKey is missing or invalid. |
| 50000 | Show Package Not Available! | The Registration Opcode was specified, but the show package by ShowPackageKey is not available or has expired. |
| -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 zero (0) indicate success (no error).
In addition to the opcode recap, data elements are output for each opcode 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. For text, they are listed as a header line, 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.