Service Desk WS API requests always returns a default response. A response status can be used to determine whether the request has succeeded or failed. The default response comprises of a status code and an associated status text message.
The status message is a short description in English that can be displayed to the user. If you display the status message, you should also display the status code.
Clients can recognize the status codes, not the status messages. When a request cannot be completed successfully, the actual fault or an error message returns. This behavior can vary slightly from the messages that are listed in this appendix.
Some faults are particular to certain calls, while others are more general faults that can occur on any call. For example, status code 100 for an access is denied due to invalid credentials.
| 0xx : Success Status Code | Message |
| 000 | Success: The request was successfully fulfilled by the server; the service returned results of the operation. |
| 001 | Success: The request was successfully fulfilled by the server; no results were returned by the service. |
| 1xx : Authorization Error Status Code | Message |
| 100 | Unauthorized: Access is denied due to invalid credentials. |
| 101 | License Error: You do not have an appropriate license to use any service. |
| 2xx : Operation Access Error Status Code | Message |
| 200 | Invocation Error: The operation definition for the requested service was not found. |
| 201 | Invocation Error: The requested service operation has been disabled. |
| 3xx : Operation Pre-processing Error Status Code | Message |
| 300 | Execution Error: An unexpected error occurred during data-transformation of the request parameters passed during invocation of the web service: { 0} .{ 1} . |
| 301 | Execution Error: An unexpected error occurred during data-validation of the request parameters passed during invocation of the web service: { 0} .{ 1} . |
| 4xx : End-point Execution Error Status Code | Message |
| 400 | Execution Error: An un-handled exception occurred within the service endpoint (provider) during execution of the requested service. |
| 401 | Execution Error: Some errors were captured by the service endpoint (provider) during execution of the requested service. |
| 402 | Execution Error: An unexpected error occurred when rendering the service response in the requested format. |
| 403 | Execution Error: An unexpected error occurred while processing the requested service. |
Add Comment