Booth Documents/Links OpCode DD: Delete Booth Document/Link

This opcode is used to delete a document/link from the specified Booth. The Booth to remove the document may be identified via the BoothKey, BoothExternalID, or BoothTitle parameters. The attachment to delete may be identified by specifying the BoothAttachmentKey or through the Attachment parameter (for URLs, this is the actual value, while for file uploads, this is the filename).

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 DL 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 retrieve.
BoothExternalID	Varchar 255	N	External ID or code to cross-reference this booth entry.
BoothTitle	Varchar 128	N	Title for this booth.
BoothAttachmentKey	Integer	N	The Attachment Key value to update.
AttachmentDescription	Varchar 800	Y	The description of this attachment.
Attachment	Varchar 2000	N	If the attachment is a link, rather than a file upload, then this contains the URL. Otherwise, this parameter should be omitted.

Return Outputs

This API returns the status message OK and the old AttachmentKey upon successful completion.

Text

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

## OpCode=DD Status=0 Message=OK

AttachmentKey

123456

HTTP URL-encoded

APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1& OpCodesInError=0&OpCode=DD&Status=0&Message=OK&AttachmentKey=123456

XML

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

</ResultRow>

</OpCodeResult>

</APIResults>

Potential Error Codes

Error	Message	Reason
801	Invalid ShowKey Specified!	The ShowKey parameter value specified is invalid.
802	Invalid Booth Specified!	The booth to retrieve data could not be located based on the value passed for BoothKey, BoothExternalID, and BoothTitle.
805	Attachment Not Found!	The attachment entry to update was not found based on values provided in BoothAttachmentKey and Attachment parameters.