The REST API is using default HTTP status codes for responses. These are returned in the HTTP header. If e.g. a document has been archived successfully, the respective resource is returning the status code 201 (Created).
In the following you find some examples, that lead to errors and are answered with error codes (400 to 500):
•User is not authenticated (401 Unauthorized)
•User has no rights for the requested resource (403 Forbidden, e.g. requested archive is inactive).
•The requested resource does not exist (404 Not Found)
•The request contains data, that the server could not handle (422 Unprocessable Entity, e.g. the format of the date value is not valid)
•An error occurred on the server (500 Internal Server Error, e.g. the database is not accessible).
The error codes and messages, that every resource can return, are described in the REST API reference of your JobRouter:
http://example.org/jobrouter/api/rest/v2
The error cases have to be handled by the client accordingly.
