Exhibitor OpCode EL: List Users For An Exhibitor
Exhibitor OpCode EL: List Users For An Exhibitor
This opcode is used to list exhibitor users for an existing Exhibitor in the tenant area. The Exhibitor to list users for may be specified via the ExhibitorKey, ExhibitorExternalID, or ExhibitorName parameters.
Calling the API
The API is called via a secure HTTPS request. This HTTPS request may be a GET or POST operation (except for file uploading which requires a multi-part form post). 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!50550&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&OpCodeList={Opcode[OpCode[…]]}&OutputFormat={X|H|T(default)}&{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!50550. All other parameters may appear in any sequence order.
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 2000 |
Y |
Should include EL to invoke this function. |
OutputFormat |
Char 1 |
N |
T for text, H for HTTP URL-encoded, or X for XML. Defaults to T. |
ExhibitorKey |
Integer |
N |
The key value identifying the exhibitor to list users for. |
ExhibitorExternalID |
Varchar 255 |
N |
External ID or code to cross-reference this exhibitor entry. |
ExhibitorName |
Varchar 80 |
Y |
Name for this exhibitor. |
Return Outputs
This API returns a result set of user information upon successful completion. The result set is structured as follows:
Column |
Type/Size |
---|---|
ShowUserKey |
Integer |
Name |
Varchar 80 |
EMailAddress |
Varchar 255 |
Potential Error Codes
Error |
Message |
Reason |
---|---|---|
301 |
Missing Or Invalid Exhibitor! |
The exhibitor to list users for could not be located based on the value passed for ExhibitorKey, ExhibitorExternalID, and ExhibitorName. |