Event Attachment OpCode EAI: Add an Attachments to an Event

This opcode is used to add a new attachment to the list of attachments (documents/links) for the specified event. The event to add the attachment to may be identified by specifying the EventKey, EventDescription, or EventCode.

Attachments can be links (URLs) or actual files uploaded to the system. When adding 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 multi-part form posts. An example html form below illustrates this:

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.

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=EAI Status=0 Message=OK

AttachmentKey

123456

HTTP URL-encoded

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

XML

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

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

<OpCodeResult OpCode="EAI" Status="0" Message="OK" >

 <ResultRow>

  <AttachmentKey>123456</AttachmentKey>

 </ResultRow>

</OpCodeResult>

</APIResults>

Potential Error Codes