Status Codes
When you call any REST endpoint, the response header returns one of the standard HTTP status codes listed in the following table. These status codes refer to a three-digit number in the response header that indicates the general classification of the response. For example, the codes indicate whether the request was successful (200s), or resulted in a client (400s) or server (500s) error. The 400 and 500 classes of status codes help in troubleshooting bad requests.
HTTP Status Code | Description |
---|---|
200 OK
|
Success! A successful GET or POST method returns a 200 status
code. For example, for a Create
an engagement request, a 200 status code indicates that the
chat session was successfully created.
|
400 Bad Request |
The validation of the request object failed. It indicates that the request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth. |
403 Forbidden
|
For a Create an
engagement request, the status 403 indicates that the
validation on the JSON Web Token (JWT) failed. For other endpoints
where it is supported, the status 403 indicates that the consumer
session identifier was unknown . It indicates that you do not have
authorization to perform this request. You may not have the
necessary roles and privileges to use this REST resource. It is not
supported on the Retrieve queue
statistics endpoint.
Note: Access to cloud resources is governed by the US Export Laws and is internally monitored by Oracle Global Trade Compliance (GTC). Make sure that you are compliant with the US Export Laws and that you are accessing the REST resource from a location that Oracle permits to access the associated cloud service. Otherwise, you might continue to get the 403 HTTP status code in the response. |
404 Not Found
|
The resource was not found. It indicates that the client was able to communicate with the server, but the server could not find what was requested. |
408 Request Timeout |
This error can occur with requests
that use continuations. A continuation is a means within the Jetty
web server to suspend an HTTP request for a period of time. If the
continuation times out, a 408 status code is returned. This is only
applicable to the Create an engagement endpoint.
|
409 Conflict |
The engagement was removed from the queue via the routing rules. |
500 Internal Server Error |
An error occurred in the chat server while processing the request. |
501 Not Implemented |
Indicates that the server doesn't support the method used in the request, and therefore it can't process the request. |
503 Service Unavailable |
Indicates that the server is unable to complete the request due to a server overload. This condition is usually temporary. |
504 Gateway Timeout |
The server acts as the gateway and doesn't receive a timely response from the upstream server to complete the request. |
For more information on the status codes, see the Internet Engineering Task Force (IETF) website.