Event Attachment OpCode EAL: List Attachments for an Event
Event Attachment OpCode EAL: List Attachments for an Event
This opcode is used to retrieve a list of attachments (documents/links) for the specified event. The event to retrieve the list of attachments for may be identified by specifying the EventKey, EventDescription, or EventCode.
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 EAL 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 to retrieve the attachments list for. |
EventCode |
Varchar 255 |
N |
The event code to retrieve the attachments list for. |
EventDescription |
Varchar 355 |
N |
The description of the event to retrieve the attachments list for. |
Return Outputs
This API returns a result set of event attachment information upon successful completion. The result set is structured as follows:
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 |
---|---|---|
80 |
Event Not Found! |
The function could not find a matching event entry based on the values supplied in EventKey, EventCode, and EventDescription. |