Die REST-API benutzt bei Antworten die Standard-HTTP-Statuscodes. Diese werden im HTTP-Header zurückgeliefert. Wurde z. B. ein Dokument erfolgreich archiviert, liefert die entsprechende Ressource den Statuscode 201 (Created) zurück.
Folgend ein paar Beispiele, die zu Fehlern führen und mit Fehlercodes beantwortet werden (400 bis 500):
•Benutzer ist nicht authentifiziert (401 Unauthorized)
•Benutzer hat keine Rechte für die angeforderte Ressource (403 Forbidden, z. B. angefordertes Archiv ist inaktiv).
•Die angeforderte Ressource existiert nicht (404 Not Found)
•Die Anfrage enthält Daten, die vom Server nicht verarbeitet werden konnten (422 Unprocessable Entity, z.B. Datumswert wurde im falschen Format übertragen)
•Es ist ein Fehler auf dem Server aufgetreten (500 Internal Server Error, z. B. die Datenbank ist nicht erreichbar).
Die Fehlercodes und -meldungen, die jede Ressource zurückliefern kann, sind in der REST-API-Referenz Ihres JobRouter beschrieben:
http://example.org/jobrouter/api/rest/v2
Die Fehlerfälle müssen vom Client entsprechend behandelt werden.
