OpCode A: Get User Registration Add-On information
OpCode A: Get User Registration Add-On information
This opcode is used to retrieve details of a user’s registration Add-On(s) for the specified show in the VTS system. Both attendees (default) and exhibitor users can be registered. The user must already exist. If LookupByExternalUserID is specified as one (1), then the user is located based on the ExternalUserID value. Otherwise, the user is located based on EMailAddress. Several conditions would prevent successful retrieval, such as the given show does not require registration or the user is not registered for the show.
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!50500&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!50500. All other parameters may appear in any sequence.
| 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. |
| OpCodeList | Varchar 20 | Y | Should include I to invoke this function. |
| OutputFormat | Char 1 | N | T for text, H for HTTP URL-encoded, or X for XML. Defaults to T. |
| LookupByExternalUserID | Bit (0/1) | N | Pass one (1) to look up this person by the supplied ExternalUserID (your internal identifier). |
| ExternalUserID | Varchar 255 | - | Your internal identifier for this person. This value must be unique for each person. |
| EMailAddress | Varchar 255 | - | The person’s email address. |
| ShowKey | Integer | Y | The show identifier to check the registration of the user. |
Return Outputs
This API returns a result set of profile information upon successful completion. The result set is structured:
| Column | Type/Size |
|---|---|
| ShowPackageAddOnItemKey | Integer |
| Description | Varchar 800 |
| DetailItemType |
0 = Show Package 1 = Event Track (Package) 2 = Event 4 = All Events 5 = After Show Access 6 = Show Floor Access 7 = Exhibit Access 8 = Specific Booth Access |
| DetailItemKey | Integer |
| DateAdded | Varchar 30 in ODBC format (YYYY-MM-DD HH:MM:SS) |
| Expired | Varchar(3)Yes/No if the Add-On item is expired. |
| ShowPackageAddOnItemKey | Integer |
| Description | Varchar 800 |
Potential Error Codes
| Error | Message | Reason |
|---|---|---|
| 61 | Show Does Not Require Registration! | There is no registration for this show. |
| 62 | User Not Found! | The user with either the specified ExternalUserID or EMailAddress could not be found. |
| 63 | User Not Registered! | The specified user is not registered for this show. |