422 ValidationError

Validation Error (422)

This error is returned when a request is made with invalid parameters. It signifies that the server understands the request but refuses to process it due to client-side errors. The response in this case contains detailed information about errors in the parameters.

The typical JSON object returned for this error is as follows:

{
  "name": "ValidationError",
  "message": "Parameters validation error!",
  "code": 422,
  "type": "VALIDATION_ERROR",
  "statusCode": 422,
  "status": "error",
  "data": [
    {
      "type": "required",
      "message": "The 'query' field is required.",
      "field": "query"
    }
  ]
}

Fields in the returned object:

name: string

The name of the error. For this error, the name will always be "ValidationError"

message: string

A string containing a summary of why the error occurred.

code: integer

The HTTP status code for the error. The code "422" signifies that the request was well-formed but was unable to be followed due to semantic errors.

type: string

This field indicates the type of the error. For this error, the type will be "VALIDATION_ERROR"

statusCode: integer

The HTTP status code of the error returned in the response.

status: string

Status of the response. The status "error" signifies that the request couldn't be processed due to some error condition.

data: [object]

An array providing the detailed validation errors and additional context:

type: string. The type of validation that failed, such as "required".
message: string. A human-readable explanation of the error.
field: string. The name of the parameter that has the error.

Last modified: 09 February 2024