Response codes indicate if the request was successful or if an
error occurred.
The following table describes commonly returned response codes:
| Response Code
|
Description
|
Example
|
| 2xx
|
Indicates successful requests
|
- 200 OK:
Returned for all GET, PATCH and PUT requests and when POSTing a collection.
- 201
Created: Returned when a new entity was created via a POST.
|
| 4xx
|
Indicates a problem on the client side
|
- 400 Bad
Request: There was a syntax error with the request such as an invalid value
in the request payload.
- 401
Unauthorized: The request was missing authentication or had invalid
authentication.
- 403
Forbidden: The request was authenticated but not authorized to act on that
resource.
- 404 Not
Found: The requested resource doesn’t exist.
- 405 Method Not
Allowed: The resource you called doesn’t support the verb used in the
request.
- 413 Request
Entity Too Large: The response payload is over 10 megabytes.
|
| 5xx
|
Indicates a problem on the server side
|
- 500 Internal
Server Error: This is a generic error message and may indicate a defect in
the resource or an infrastructure outage.
- 503 Service
Unavailable: The resource you have called is down for maintenance.
- 504 Gateway
Timeout: The request timed out on the gateway.
|
These response codes follow the standards defined
here.