Mögliche Antworten auf eine Anfrage¶
Alle API-Anfragen geben einen Statuscode und ein Objekt zurück, das Ihnen Aufschluss über den Erfolg oder mögliche Fehler, wie fehlende Informationen oder Berechtigungen, gibt.
Mögliche Statuscodes¶
| Statuscode | Erklärung | Objekt |
|---|---|---|
| 200 OK | Die Anfrage war erfolgreich. | QueryVO |
| 201 Created | Die Anfrage war erfolgreich und es wurde ein neues Objekt erstellt. | ResultVO |
| 202 Accepted | Die Anfrage war erfolgreich, wurde jedoch noch nicht abgeschlossen. Dies kann der Fall sein, wenn die Anfrage einen Prozess anstößt, wie das Ändern einer Konfiguration, die bis zu 7 Minuten braucht, bis sie umgesetzt wurde. |
ResultVO |
| 400 Bad Request | Die Anfrage war nicht erfolgreich. Die Anfrage war fehlerhaft oder es fehlen Informationen. | ViolationVO |
| 401 Unauthorized | Die Anfrage war nicht erfolgreich, da die Authentifizierung der Anfrage fehlerhaft war. | ViolationVO |
| 403 Forbidden | Die Anfrage war nicht erfolgreich, da das verwendete Konto nicht über die erforderlichen Berechtigungen verfügt. | ViolationVO |
Verwendete Objekte¶
| Name | Definition |
|---|---|
| QueryVO | Ein Objekt QueryVO wird zurückgegeben, wenn eine Liste von Objekten aus einer GET-Anfrage empfangen wird. |
| ResultVO | Bei erfolgreichen POST-, PUT- und DELETE-Anfragen wird ein Objekt ResultVO zurückgegeben. |
| ViolationVO | Bei fehlerhaften Anfragen wird ein Objekt ViolationVO zurückgegeben. |