Booth Staffer OpCode SI: Add Staffer To A Booth

This opcode is used to add a show user as a staffer to a specified Booth. The Booth to add staffing information for may be identified via the BoothKey, BoothExternalID, or BoothTitle parameters. The staffer to add may be identified via the StafferUserKey or StafferEMailAddress 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 SI to invoke this function.
OutputFormat	Char 1	N	T for text, H for HTTP URL-encoded, or X for XML. Defaults to T.
ShowKey	Integer	Y	The Show Key that the booth exists in.
BoothKey	Integer	N	The key value identifying the booth to add staff to.
BoothExternalID	Varchar 255	N	External ID or code to cross-reference this booth entry.
BoothTitle	Varchar 128	N	Title for this booth.
StafferUserKey	Integer	N	Show User Key to add as a staffer.
StafferEMailAddress	Varchar 255	N	The email address of the show user to add as a staffer.
IsBoothAdmin	Bit (0/1)	N	Specify 1 if this user is an administrator or 0 if they are just a staffer.
CanEditJob	Bit (0/1)	N	Specify 1 if this user can edit job postings, else 0.
HideFromRepList	Bit (0/1)	N	Specify 1 if this user should not appear in the booth rep list, else 0.

Return Output

This API returns the status message OK upon successful completion.

Text

### APICallResult=0 APICallDiagnostic=OK OpCodesProcessed=1 OpCodesInError=0

## OpCode=SI Status=0 Message=OK

HTTP URL-encoded

APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1& OpCodesInError=0&OpCode=SI&Status=0

XML

<?xml version="1.0" encoding="utf-8" ?>

</APIResults>

Potential Error Codes

Error	Message	Reason
701	Invalid ShowKey Specified!	The ShowKey parameter value specified is invalid.
702	Invalid Booth Specified!	The booth to retrieve data could not be located based on the values passed for BoothKey, BoothExternalID, and BoothTitle.
703	Invalid Staffer Specified!	The show user to add as a staffer could not be located based on the values passed for StafferUserKey and StafferEMailAddress.
704	Staffer Already Exists!	This user is already a staffer for this booth.