Booth Documents/Links OpCode DU: Update Booth Document/Link

This opcode is used to update a document/link for the specified Booth. The Booth to update the document may be identified via the BoothKey, BoothExternalID, or BoothTitle parameters. The attachment to update 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).

Document/Link attachments can be links (URLs) or actual files uploaded to the system. When updating URL links, no special treatment is necessary. However, when uploading files, certain steps must be taken. File uploads must be the only opcode specified in the OpCodeList. This means that uploading files must be done as separate calls to the API. Additionally, uploading of files must be done using HTTPS multipart form posts.

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.
AttachmentData	Binary blob	N	If the attachment is a file upload, then this parameter contains the actual document contents. Otherwise, this parameter can be omitted.
AttachmentCategory	Integer	N	Category for this attachment. (See OpCode CTL)
AttachmentSubjectCategoryKey	Integer	N	Subject Category of this attachment. (See OpCode SCL)
AttachmentDisplayOrder	Integer	N	Display order index to be used when listing attachments.

Return Outputs

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

Text

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

## OpCode=DU Status=0 Message=OK

AttachmentKey

123456

HTTP URL-encoded

APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1& OpCodesInError=0&OpCode=DU&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.
803	Attachment Must Have A Filename or Description!	At least one of these values must be specified.
804	Invalid Subject Category Specified!	The AttachmentSubjectCategoryKey was specified and is invalid.
805	Attachment Not Found!	The attachment entry to update was not found based on values provided in BoothAttachmentKey and Attachment parameters.