Start
/
API-Referenz
/
API-Dokumentation (XML/ JSON)
/
Auftragstypen
/
Polling-Auftragstypen

Poll Info

API-Referenz (XML/JSON) · Aktualisiert 2023-09-07

Funktion

Mit dem Auftragstyp PollInfo rufst du die jeweils erste in der Message-Queue bereitgehaltene Benachrichtigung ab.

Beachte, dass immer nur eine Benachrichtigung abholt werden kann. Um auf die nächste Benachrichtigung zugreifen zu können, muss jeder Abruf mit Poll Confirm bestätigt werden.

Beschreibung

Verwendet: Objekt PollMessage

Route: GET /poll
Es muss kein Body mitgeschickt werden.

{
}

{
    "stid": "20190628-test-15934",
    "status": {
        "code": "S0905",
        "text": "Die Benachrichtigung wurde erfolgreich abgerufen.",
        "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-3384",
            "messages": [
                {
                    "text": "Die Domain wurde erfolgreich registriert, konnte aber nicht konnektiert werden.",
                    "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"
                }
            }
        }
    ]
}

Beispielantwort ohne Nachricht (Message-Block). Aktuell ist keine Information zum Polling verfügbar

{
    "stid": "20210308-test-7900",
    "status": {
        "code": "S0905",
        "text": "Die Benachrichtigung wurde erfolgreich abgerufen.",
        "type": "SUCCESS"
    },
    "object": {
        "summary": 0
    }
}

Auftragstyp-Code: 0905
Verwendet Objekt Message

<request>
    <auth>
        <user>USER</user>
        <password>PASSWORD</password>
        <context>CONTEXT</context>
    </auth>
    <task>
        <code>0905</code>
    </task>
</request>

Beispielantwort 1 mit Nachricht (Message-Block). Nachricht wurde abgerufen.

<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>Die Domain wurde erfolgreich registriert.</text>
						<code>S0101</code>
						<type>success</type>
					</status>
					<ctid>379</ctid>
				</job>
			</message>
		</data>
		<!-- Status des Poll Request -->
		<status>
			<code>S0905</code>
			<text>Die Benachrichtigung wurde erfolgreich abgerufen.</text>
			<type>success</type>
		</status>
	</result>
	<stid>20101217-TEST-41</stid>
</response>

Beispielantwort 2 ohne Nachricht (Message-Block). Aktuell ist keine Information zum Polling verfügbar

<response>
	<result>
		<data>
			<summary>0</summary>
		</data>
		<status>
			<code>S0905</code>
			<text>Die Benachrichtigung wurde erfolgreich abgerufen.</text>
			<type>success</type>
		</status>
	</result>
	<stid>20101217-TEST-39674</stid>
</response>