❗️Error Codes

​

Error Response Format

The Assessment APIs returns custom error messages for invalid requests in addition to HTTPS codes. The failed response contains some properties. These properties and their values are more indicative of the underlying error.

​

Error Response Syntax

{
    "error": {
        "error_code": "unique_error_code",
        "display_message": "Display message for the user",
        "message":  "Actual error message from the server"
    }
}

​

Error Fields

The Error field represent an error occurred while processing the request. It contains a list of errors. Developers can identify the request is not succeeded based on this field. Here is the the example of response in case of missing field in the request body.

{
    "error": {
        "error_code": "missing_field",
        "display_message": "Uh huh, you missed a required field",
        "message": "Missing required field - gender"
}

Here is the description of each error fields present in above error body

​

Error Codes

These are the custom error code field present in failure response body. There can be various factor that can cause the request to fail. Sometimes this kind of errors needs to be grouped according the the reason of failure. This allows developers to diagnose the errors faster.

​

List of Error Codes

Here is the list of most common error codes that can be returned by the API.