Booth Documents/Links OpCode DL: List Booth Documents/Links

This opcode is used to retrieve information about documents and links (attachments) assigned to the specified Booth. The Booth to retrieve document information for may be identified via the BoothKey, BoothExternalID, or BoothTitle 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 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.

Return Outputs

This API returns a result set of document information upon successful completion. The result set is structured:

Column	Type/Size
ItemTitle	Varchar 800
ItemDescription	Varchar 800
Attachment	Varchar 2000
DatePosted	Datetime
AttachmentKey	Integer
AttachmentSize	Integer
CategoryDesc	Varchar 80
Category	Integer
SubjectCategory	Varchar 80
SubjectCategoryKey	Integer
DisplayOrder	Integer
FormattedSize	Varchar 20
DisplayIcon	Varchar 255

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.