HTTP Status Codes and Error Handling
When you call any of the REST API for Conversations resources, the Response header returns one of the HTTP status codes defined in the following table.
HTTP Status Code | Description |
---|---|
200 OK |
The request was successfully completed. A 200 status is returned for a successful GET or POST method. |
400 Bad Request |
The request could not be processed because it contains missing or invalid information, such as a validation error on an input field or a missing required value. |
401 Unauthorized |
The request is not authorized. The authentication credentials included with this request are missing or invalid. |
403 Forbidden |
The user cannot be authenticated. The user does not have authorization to perform this request. |
404 Not Found |
The request includes a resource URI that does not exist. |
405 Method Not Allowed |
The HTTP verb specified in the request (DELETE , GET , POST , or PUT ) is not supported for this request URI. |
423 Locked |
The requested resource is locked by another user. |
470 Oracle SSO Logout |
This is the Oracle SSO logout to indicate that OSSO logout has been performed so that the application can redirect to a URL after logout. |
499 Oracle SSO Login |
This status is set if Oracle SSO (mod_osso) is enabled and the user details are not found in the request. Oracle SSO returns 499 to request authentication. |
500 Internal Server Error |
The server encountered an unexpected condition that prevented it from fulfilling the request. |
599 Unknown |
This status is returned when none of the preceding exception criteria matches. |
For all responses, the status code is also available in the actual payload in the StatusCode
field. For all non-HTTP Status 200 responses, a message explaining the cause of the error is available in the return value. For example:
{
"StatusCode" : "401",
"StatusCode" : "Unauthorized",
"ResourceID" : "waggle.modules.realm.InvalidLogin",
"ResourceMessage" : "Login required."
}
Exception Response Fields
Field | Description |
---|---|
statusCode | The HTTP status code. |
statusMessage | The HTTP status message. |
exceptionID | The exception ID. |
exceptionClass | The exception class. |
exceptionMessage | The exception message. |
exceptionDate | The exception date. |