Event Attachment OpCode EAD: Delete an Attachment from an Event

This opcode is used to delete an existing attachment in the list of attachments (documents/links) for the specified event. The event to delete the attachment from may be identified by specifying the EventKey, EventDescription, or EventCode. The attachment to delete may be identified by specifying the EventAttachmentKey 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 API call is: https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50540&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&OpCodeList={Opcode[OpCode[…]]}&OutputFormat={X|H|T(default)}&ShowKey={ShowKey}&{Additional, opcode-specific parameters in name=value format…}

Specific parameter ordering is unimportant, with the only restriction being that the first parameter MUST BE LASCmd=AI:4;F:APIUTILS!50540. 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 EAD 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 ShowKey that the event belongs to.
EventKey	Integer	N	The event key of the attachment to delete.
EventCode	Varchar 255	N	The event code of the attachment to delete.
EventDescription	Varchar 355	N	The description of the event of the attachment to delete.
EventAttachmentKey	Integer	N	The Attachment Key value to delete.
Attachment	Varchar 2000	N	If the attachment is a link, rather than a file upload, then this contains the URL. Otherwise, this parameter identifies the file name.

Return Outputs

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

Text

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

## OpCode=EAD Status=0 Message=OK

AttachmentKey

123456

HTTP URL-encoded

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

XML

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

</ResultRow>

</OpCodeResult>

</APIResults>

Potential Error Codes

Error	Message	Reason
80	Event Not Found!	The function could not find a matching event entry based on the values supplied in EventKey, EventCode, and EventDescription.
84	Attachment Not Found!	The attachment entry to update was not found based on values provided in EventAttachmentKey and Attachment parameters.