- Home
- API reference
- API documentation (JSON/XML)
- Tasks
- Polling tasks
Poll info
Function
With the task PollInfo you retrieve the first notification available in the message queue.
Note that only one message can be retrieved at a time. To access the next one, each fetch must be confirmed with Poll Confirm.
Description
Uses PollMessage object
Route: GET /poll
No body has to be send with.
{
}{
"stid": "20190628-app2-dev-15934",
"status": {
"code": "S0905",
"text": "The notification was polled successfully..",
"type": "SUCCESS"
},
"object": {
"type": "Message",
"value": "5003711",
"summary": 1
},
"data": [
{
"id": 5003711,
"job": {
"created": "2019-06-28T10:16:40.000+0200",
"updated": "2019-06-28T10:17:12.000+0200",
"status": "SUCCESS",
"execution": "2019-06-28T10:17:10.000+0200",
"id": 4297540404
},
"stid": "20190628-app1-dev-3384",
"messages": [
{
"text": "Domain was registered successfully, but could not be connected.",
"code": "MSG01002",
"status": "NOTICE"
}
],
"object": {
"type": "Domain",
"value": "example",
"data": {
"created": "2019-06-28T10:16:55.000+0200",
"owner": {},
"updater": {},
"name": "polling333.de",
"registryStatus": "ACTIVE",
"nameServers": [
{
"name": "ns1.nameserver.com"
},
{
"name": "ns2.nameserver.com"
}
],
"period": {
"unit": "YEAR",
"period": 1
},
"registrarStatus": "ACTIVE",
"rddsOptIn": "NOT_SET",
"ownerc": {
"id": 23151426
},
"adminc": {
"id": 23151426
},
"techc": {
"id": 23151426
},
"zonec": {
"id": 23151426
},
"payable": "2020-06-28T10:16:55.000+0200",
"action": "CREATE",
"autoRenewStatus": "TRUE"
}
}
}
]
}
Task code: 0905
Uses Message object
<request>
<auth>
<user>USER</user>
<password>PASSWORD</password>
<context>CONTEXT</context>
</auth>
<task>
<code>0905</code>
</task>
</request>Example response 1 without message (message block). Currently no polling information is available.
<response>
<result>
<data>
<summary>2</summary>
<message>
<id>1040</id>
<owner>
<user>customer</user>
<context>4</context>
</owner>
<job>
<domain>
<name>test-1292497929.eu</name>
<ownerc>10458844</ownerc>
<adminc>10458843</adminc>
<techc>10458843</techc>
<zonec>10458843</zonec>
<nserver>
<name>ns1.example.com </name>
</nserver>
<nserver>
<name>ns2.example.com</name>
</nserver>
<period>1</period>
<extension/>
<owner>
<user>customer</user>
<context>104</context>
</owner>
</domain>
<created>2010-12-16 12:59:51</created>
<nic_response></nic_response>
<status>
<text>Domain has been registered successfully.</text>
<code>S0101</code>
<type>success</type>
</status>
<ctid>379</ctid>
</job>
</message>
</data>
<!-- Status des Poll Request -->
<status>
<code>S0905</code>
<text>The notification was polled successfully.</text>
<type>success</type>
</status>
</result>
<stid>20101217-TEST-41</stid>
</response>Example response 2 with message (message block). Message was retrieved.
<response>
<result>
<data>
<summary>0</summary>
</data>
<status>
<code>S0905</code>
<text>The notification was polled successfully.</text>
<type>success</type>
</status>
</result>
<stid>20101217-TEST-39674</stid>
</response>