poll_event
Sends a request for a list of the most recent event transactions. A maximum of 100 events can be queried at a time, and all will be listed in chronological order, starting with the earliest event.
Request Parameters for poll_event
Standard Parameters
- action = poll
- object = event
Attributes
Parameters within the attributes associative array are described below.
Parameter name | Obligation | Definition/Value |
---|---|---|
limit | Optional | A numeric value which determines how many event transactions will be listed in the response. Events will be listed in chronological order, starting with the earliest event. Max value: 100 Notes: If not limit value is indicated, the default value is 1. |
Example Request for poll_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">POLL</item>
<item key="attributes">
<dt_assoc>
<item key="limit">100</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Example Response for poll_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:14:02 23004 101</item>
<item key="action">REPLY</item>
<item key="attributes">
<dt_assoc>
<item key="events">
<dt_array>
<item key="0">
<dt_assoc>
<item key="object_data">
<dt_assoc>
<item key="domain_name">abc-fictional.de</item>
<item key="domain_id">801743</item>
<item key="zone_check_status">invalid</item>
</dt_assoc>
</item>
<item key="object">DOMAIN</item>
<item key="event_id">6887c7d3838dcaec7517c531df527bb7</item>
<item key="event">ZONE_CHECK_STATUS_CHANGE</item>
<item key="event_date">2014-05-27T19:29:25Z</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="total">1</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Updated almost 6 years ago