Poll:retrieve
Retrieve messages from the queue
When changes take place in the registration data for domain names, we save poll messages notifications. You can retrieve these notifications via this command. If the message queue is not empty, then a successful response to a poll command returns the first message from the queue. This response includes a unique message identifier and a counter that gives the number of messages in the queue. After a message has been received, you must respond with an explicit acknowledgement to confirm that the message has been received. Then that message is dequeued and the next message in the queue becomes available for retrieval.
XML Template
<?xml version="1.0" encoding="UTF-8"?>
<request xmlns:poll="http://www.eurodns.com/poll">
<poll:retrieve/>
</request>
<poll:retrieve> (Occurrences: 1)
The following code will be returned:
<?xml version="1.0" encoding="UTF-8"?>
<response xmlns:message="http://www.eurodns.com/message" xmlns:poll="http://www.eurodns.com/poll">
<result code="1000">
<msg><![CDATA[Command completed successfully]]></msg>
</result>
<resData>
<poll:data>
<poll:numMessages>#MESSAGE COUNTER#</poll:numMessages>
</poll:data>
<poll:message>
<message:id>#MESSAGE ID#</message:id>
<message:crDate>#MESSAGE CREATION DATE#</message:crDate>
<message:class status="#MESSAGE STATUS#">#MESSAGE CLASS#</message:class>
<message:data>#MESSAGE DATA#</message:data>
<message:domain>#MESSAGE DOMAIN#</message:domain>
</poll:message>
</resData>
</response>
<poll:message> (Occurrences: 1)
R | #MESSAGE COUNTER# | The number of poll messages that have not been acknowledged |
< poll:message > (Occurrences: 0,1)
Note: This section is only present if there is at least one message in the queue
R | #MESSAGE ID# | The identifier of the poll message |
R | #MESSAGE CREATION DATE# | The creation date of the poll message |
R | #MESSAGE STATUS# | The status of the submission (view list) |
R | #MESSAGE CLASS# | The class of the submission (view list) |
R | #MESSAGE DATA# | The message data containing additional information |
R | #MESSAGE DOMAIN# | The name of the domain related to the message |
Legend
O | The element is optional and does not have to be specified in the request and/or answer |
R | The element is mandatory and has to specified in the request and/or answer |