About Task Acknowledgement (ACK) Messages

The Run Task Request can be either acknowledged or rejected by server. The message sent back to user has the following structure:

Elements of XML

Description

Elements of XML

Description

<EagleML  eaglemlVersion="2-0"  eaglemlType="TaskAcknowledgement"  xsi:schemaLocation="http://www.eagleinvsys.com/2011/EagleML-2-0 eagleml-main-2-0.xsd"  xsi:type="TaskAcknowledgement"  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  xmlns="http://www.eagleinvsys.com/2011/EagleML-2-0">

Root Node. Its content is fixed

<header>     <messageId>B41D0J51DFFIMKCY</messageId>     <sentBy>http://www.eagleinvsys.com/</sentBy>     <sendTo>www.client.com</sendTo>     <creationTimestamp>2014-11-30T08:55:11-05:00</creationTimestamp> </header>

Message Header section.

messageId node must be unique

sentBy is a constant

sentTo is a constant

creationTimestamp – message generation time

<taskIdentifier>     <correlationId>unique_correlation_id</correlationId>     <businessTaskId>EGLWS_RPT_20141130</businessTaskId> </taskIdentifier>

Task Identifier section.

correlationId is a required node and must be unique

businessTaskId is a required node and should describe the task. It can be a constant

Task EJM status. If the value is “true”, current EJM Task is not started and the failure reason is described in the next section.

Reason Section.

reasonTypeEnum is a constant

reasonCode is a number, representing error code

description contains error details

The most important elements are <isNegative> and <reason>, as they carry the information about acknowledgement status and the reason for its rejection in case it was rejected.