About API Responses
All responses from APSIS Ones APIs use HTTP status codes. Additional information is returned as JSON in the response body.
Keep an eye on the JSON body for additional details about responses, especially when receiving errors. Different errors may result in the same HTTP status code, and the JSON body will allow you to identify what caused the error.
HTTP Status Codes
Successful requests to APSIS One APIs will have HTTP status codes starting with 2, whereas unsuccessful requests will have HTTP status codes starting with 4 or 5.
Here's an overview of APSIS Ones APIs status codes:
Success Codes
Code | Meaning | Methods |
200 OK | Success. | all |
201 Created | Created. | POST, PUT |
202 Accepted | The request was successful and will be handled. | POST, PUT, PATCH, DELETE |
204 No content | No response body. | POST, PATCH, DELETE |
207 Multi-Status | The response body contains multiple status information for different parts of batch/bulk requests. | POST |
Client-Side Error Codes
Code | Meaning | Methods |
400 Bad request | Generic or unknown error. | all |
401 Unauthorized | The user must log in to proceed. | all |
403 Forbidden | The user is not authorized to use this resource. | all |
404 Not found | Resource not found. | all |
408 Request timeout | The server timed out while waiting for the resource. | all |
410 Gone | Resource is locked or is no longer available. | all |
429 Too many requests | Too many requests were sent, without considering a reasonable rate limit. | all |
Server-Side Error Codes
Code | Meaning | Methods |
500 Internal Server Error | This is a generic error for an unexpected problem related to the server. Please retry. | all |
501 Not implemented | The server cannot fulfil the request. | all |
503 Service unavailability | The service is unavailable. | all |
Note: Head over to our Developer Hub to read more about limitations.