ack_event

After an event has been polled (poll_event), each unique transaction can be acknowledged, effectively removing it from future poll_event results. Each unique transaction must be individually acknowledged .

Request Parameters for ack_event

Standard Parameters

  • action = ack
  • object = event

Attributes

Parameters within the attributes associative array are described below.

Parameter name

Obligation

Definition/Value

event_id

Required

The unique identifier of the event transaction to be acknowledged.

Response Parameters for ack_event

Standard parameters

  • action = reply
  • object = event
  • is_success = a Boolean is returned, indicating success or failure of the
    request
  • response_code = response code indicating outcome of the request
  • response_text = message describing the outcome of the request

Attributes

If the request is successful, the attributes associative array may include the
following:

Parameter name

Obligation

Definition/Value

transaction_id

Always returned

The unique identifier of the event transaction acknowledged.

Request Example for ack_event

<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="object">EVENT</item>
                <item key="action">ACK</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="event_id">6887c7d3838dcaec7517c531df527bb7</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response Example for ack_event

<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="object">EVENT</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
                <item key="response_text">Command successful</item>
                <item key="transaction_id">2014-05-29 11:17:03 22962 101</item>
                <item key="action">REPLY</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="total">0</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>