The http status code indicates the result of the operation.
When 200 OK is returned, data in JSON format will be returned with some responses. This is documented with the relevant function.
This usually indicates that a required parameter is missing. The server will provide more information in the response body (see below).
This response indicates a problem with the supplied Bearer token, or an incorrect ClientsID, or a combination of both.
This can indicate that the REST endpoint for the function being accessed does not exist, if the response body is empty.
If the REST endpoint does exist, the server will provide a JSON structure in the response body indicating the reason for the failure.
This usually indicates that an operation cannot complete, because an object which is being created (or cloned) already exists, or another precondition is not satisfied.
This indicates an internal server error has occurred. Please supply details of the rest call made, and the response received to the relevant support team.
If the server can, it will provide a JSON structure in the response body indicating the reason for the failure.
Field | Type | Meaning |
---|---|---|
status | Integer | The http status code. |
error | String | A string indicating the reason for the error. |
For example:
|