Booth Staffer OpCode SD: Delete A Staffer From A Booth

Booth Staffer OpCode SD: Delete A Staffer From A Booth

This opcode is used to remove a show user as a staffer from a specified Booth. The Booth to remove staffing information from may be identified via the BoothKey, BoothExternalID, or BoothTitle parameters. The staffer to remove may be identified via the StafferUserKey or StafferEMailAddress parameters. Note that removing a staffer does not delete the user from the show.

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 SD 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 remove staff from.

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 remove as a staffer.

StafferEMailAddress

Varchar 255

N

The email address of the show user to remove as a staffer.

 

Return Outputs

This API returns the status message OK upon successful completion.

 

Text

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

## OpCode=SD Status=0 Message=OK

 

 

HTTP URL-encoded

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

 

XML

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

<APIResults APICallResult="0" APICallDiagnostic="OK" OpCodesProcessed="1" OpCodesInError=”0” >

<OpCodeResult OpCode="SD" Status="0" Message="OK" />

</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.