HTTP-Statuscodes der REST-API
Dieses Dokument definiert die Spezifikation der HTTP-Statuscodes für die REST-API.
Statuscode-Definition
| Code | Beschreibung | Erläuterung |
|---|---|---|
| 200 | OK | Erfolg! |
| 400 | Ungültige Anfrage | Die Anfrage ist ungültig. Die entsprechende Beschreibung erklärt den Grund. |
| 401 | Nicht verifiziert | Keine Verifizierungsinformationen vorhanden oder Verifizierung fehlgeschlagen. |
| 403 | Abgelehnt | Die Anfrage wurde verstanden, aber nicht akzeptiert. Die entsprechende Beschreibung erklärt den Grund. |
| 404 | Nicht gefunden | Die Ressource existiert nicht. Der angeforderte Benutzer existiert nicht. Das angeforderte Format wird nicht unterstützt. |
| 405 | Unzulässige Anfragemethode | Die Schnittstelle unterstützt diese Anfragemethode nicht. |
| 410 | Offline | Die angeforderte Ressource ist offline. Bitte beachten Sie die entsprechende Ankündigung. |
| 429 | Zu viele Anfragen | Die Anfrage hat das Frequenzlimit überschritten. Die entsprechende Beschreibung erklärt den konkreten Grund. |
| 500 | Interner Serverfehler | Auf dem Server ist ein interner Fehler aufgetreten. Bitte kontaktieren Sie uns, um das Problem schnellstmöglich zu lösen. |
| 502 | Ungültiger Proxy | Der Dienstserver ist offline oder wird gerade aktualisiert. Bitte versuchen Sie es später erneut. |
| 503 | Temporärer Dienstausfall | Der Server konnte auf die Anfrage nicht antworten. Bitte versuchen Sie es später erneut. |
| 504 | Proxy-Timeout | Der Server läuft, kann aber auf die Anfrage nicht antworten. Bitte versuchen Sie es später erneut. |
Einzuhaltende Spezifikationen
- 2200 muss Erfolg anzeigen. Verwenden Sie den Statuscode 200 nicht für Ausnahmen.
- Bei Geschäftslogikfehlern verwenden Sie 4xx für spezielle Fehlercodes; andernfalls 400.
- Bei internen Serverfehlern, wenn kein spezifischer Fehlercode verfügbar ist, verwenden Sie 500.
- Bei Geschäftsausnahmen muss der Rückgabeinhalt im JSON-Format Fehlerinformationen enthalten.
Diese Übersicht zu HTTP-Statuscodes unterstützt Sie dabei, REST-API-Antworten korrekt zu interpretieren und effizient in Ihre Anwendungen zu integrieren.
