Previous
4.3.4 Indicating Failure
An HTTP API service response message to an unsuccessfully processed request message will have the following structure along with appropriate HTTP status codes unless it is explicitly required to have more information to be part of the response of the integration point:
<resultMessages result='F'>
<resultMessage code= ''>
messageText
</resultMessage>
</resultMessages>
The following table lists the HTTP status codes for indicating failure:
|
Code |
Meaning |
Description |
|---|---|---|
|
400 |
Bad Request |
The request could not be understood by the server due to malformed syntax (e.g. when unmarshalling of the request failed) |
|
401 |
Unauthorized |
Request failed because the user is not authenticated |
|
404 |
Not found |
The server has not found anything matching the Request URI |
|
415 |
Unsupported Media Type |
The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method |
|
422 |
Unprocessable Entity |
The syntax of the request is correct (thus a 400 (Bad Request) status code is inappropriate) but the server was unable to process the contained instructions because the data violates business rules |
|
500 |
Internal Server Error |
Something went wrong on the server, check server status and logs and/or report the issue |