- Start
- API-Referenz
- API-Dokumentation (XML/ JSON)
- Objekte
- XML-spezifische Objekte
Objekt Task
Beschreibung
Das Element Task definiert den Aufbau eines Auftragstyps. In einem Auftrag können mehrere Aufträge unterschiedlicher Auftragstypen (Task) versendet werden (Multitask).
Aufbau
| XML Keyword | Häufigkeit | Typ | Format | Beschreibung |
|---|---|---|---|---|
| code | 0 - 1 | string | Identifizierung des Auftragstyps, z. B. 0101 für DomainCreate | |
| reply_to | 0 - 1 | string | E-Mail-Adresse, an die der synchrone Auftragsstatus übermittelt wird (siehe Asynchrone Benachrichtigungen). | |
| email_confirmation | 0 - 1 | string | E-Mail-Adresse, an die die Bestätigungs-E-Mail für die erfolgreiche Annahme des Auftrages gesendet wírd. | |
| ctid | 0 - 1 | string | Die Client-Transaction-ID identifiziert den Auftrag. Sie kann z. B. verwendet werden, um eine asynchrone Antwort dem zugehörigen Auftrag zuzuordnen (siehe Asynchrone Benachrichtigungen). | |
| execdate | 0 - 1 | string | date | Zeitpunkt der Ausführung. Format: yyyy-MM-dd HH:mm:ss |
| demo | 0 - 1 | boolean | Der Auftrag wird Richtigkeit der Syntax geprüft, jedoch nicht ausgeführt.
| |
| key | 0 - n | string | Anweisungen zur Steuerung einiger Auftrags-Typen (Flags). So kann z. B. erreicht werden, dass mehr Daten zurück geliefert werden sollen. | |
| view | 0 - 1 | object | View | Legt die Anzahl der angezeigten Ergebnisse bei Listenabfragen (List inquire) fest. |
| order | 0 - n | object | Order | Legt die Sortierung der angezeigten Ergebnisse bei Listenabfragen (List inquire) fest. |
| where | 0 - 1 | object | Where | Legt die Filterung der angezeigten Ergebnisse bei Listenabfragen (List inquire) est. |
| default | 0 - 1 | any | Vorgabe-Wert für ein Objekt bei Massenaufträgen (Bulk). | |
| job_wait_timeout | 0 - 1 | int | Zeit, die ein Auftrag wartet bis ein Job abgeschlossen ist (BETA). Werte: = 0-120 | |
| 0 - 1 | string | Bewirkt das vollständige Laden der Kontakt-Daten bei einem DomainInfo-Auftrag. Das Keyword ist veraltet und wurde durch <key>full_contact</key> ersetzt. | ||
| 0 - 1 | string | Unterdrückt die Dublettenprüfung bei ContactCreate-Aufträgen und Domain-Aufträgen mit Kontaktdaten. Das Keyword ist veraltet und wurde durch <key>force_handle_create</key> ersetzt. | ||
| any | 0 - n | object | Spezifisches Objekt für den jeweiligen Auftragstyp. |
Beispiel
<task>
<code>400101</code>
<reply_to>jon.doe@example.com</reply_to>
<email_confirmation>jon.doe@example.com</email_confirmation>
<ctid>ABC123456</ctid>
<execdate>2019-01-01 09:00:00</execdate>
<demo>1</demo>
<certificate>
...
</certificate>
</task>