Poll
Read next status message from the server. Messages are sent whenever is changed status of your order.
Input fields
- op - attribute, either 'req' to read the message, or 'ack' to confirm receipt of the message and to remove it from queue. (required)
- msgID - message id to be confirmed by 'ack'. Only used with 'ack'.
Output fields
- msgQ@count - number of messages remaining (required)
- msgQ@id - identification number of currently received message (required)
- msgQ-qDate - date of sending this message
- msgQ-message - human-readable message
- resData-id - order id number (required)
- resData-domain - object which this order affects (required)
- resData-type - type of operation to be performed (eg. ModifyNS_Domain) (required)
- resData-status - status of this order (required)
- resData-errorcode - if order could not be processed, contains specific subreg errorcode
- resData-lastupdate - date of latest status modification
- resData-message - additional human-readable status message
- resData-payed - information if the order is already payed
- resData-amount - the price of the order
Example
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <command> <poll op="req"/> <clTRID>SUBREG20120218T021953Z080</clTRID> </command> </epp>
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1301"> <msg lang="en">Command completed successfully; ack to dequeue</msg> </result> <msgQ count="813" id="3"> <qDate>2011-12-03T16:18:22.0Z</qDate> <msg>Order status changed</msg> </msgQ> <resData> <order:infData xmlns:order="http://www.subreg.cz/epp/order-1.0"> <order:id>1</order:id> <order:domain>yourdomain.cz</order:domain> <order:type>Create_Domain</order:type> <order:status>Completed</order:status> <order:lastupdate>2011-12-03T16:22:10.0Z</order:lastupdate> <order:payed>1</order:payed> <order:amount>198.00</order:amount> </order:infData> </resData> <trID> <clTRID>SUBREG20120218T021953Z080</clTRID> <svTRID>SUBREG20120218T021953Z210</svTRID> </trID> </response> </epp>
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <command> <poll op="ack" msgID="3"/> <clTRID>SUBREG20120218T021953Z219</clTRID> </command> </epp>
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"> <response> <result code="1000"> <msg lang="en">Command completed successfully</msg> </result> <msgQ count="812" id="3"/> <trID> <clTRID>SUBREG20120218T021953Z219</clTRID> <svTRID>SUBREG20120218T021953Z349</svTRID> </trID> </response> </epp>
Subreg EPP server documentation - version 1.0
|