Beschreibung und Code-Beispiele

Erhält das System einen Auftrag, sendet es in Echtzeit eine Antwort mit Informationen über den Status. Diese sind im Tag <status> bzw. "status" enthalten.

Beispiel: Status-Block XML

XML
        <status>
            <type>success</type>
            <code>S0301</code>
            <text>Der Domain-Kontakt wurde erfolgreich aktualisiert.</text>
        </status>

Beispiel Status-Block JSON

Response
    "status": {
        "resultCode": "S0301",
        "text": "Der Domain-Kontakt wurde erfolgreich aktualisiert.",
        "type": "SUCCESS"

Bedeutung der Status-Codes

TypBeispiel-CodeBedeutung
successS400101S (Success) = Auftrag wurde erfolgreich angenommen.
errorE400101E (Error) = Es ist ein Fehler aufgetreten.
notifyN400101N (Notification) = Bei manchen Auftragstypen wird keine "Success"-  oder "Error"-Meldung, sondern eine zunächst eine" Notification" versendet. Dies bedeutet, dass der Auftrag angenommen wurde und weiter verarbeitet wird.
Wenn der Auftrag dann vollständig abgearbeitet worden ist, wird eine Benachrichtigung generiert, die per Polling, Push oder E-Mail abgerufen bzw. versendet wird. Sie informiert über den endgültigen Status "success" (S) oder "error" (E).

Unterschied Status-Code und Error-Code

Status-Codes beginnen immer mit einem S, E oder N und beschreiben den Status des Auftrags.  Fehlermeldungen beginnen mit einem EF und beschreiben den aufgetretenen Fehler.