Help Center
Login Sign up
  1. Home
  2. API reference
  3. API documentation (JSON/XML)
  4. Tasks
  5. Polling tasks

Poll info

API reference (XML/JSON) · Updated 2023-09-18

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"
                }
            }
        }
    ]
}