Error Responses

Error Response Formats

Bad Request (400)

• This response indicates that the request was malformed or contains invalid data.

‍
JSON Example:

{
  "validationFailures": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

‍

Unauthorized (401)

• This response indicates that the request requires authentication or that the provided credentials are invalid.

‍
JSON Example:

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "additionalProp1": "string",
  "additionalProp2": "string",
  "additionalProp3": "string"
}

‍

Forbidden (403)

• This response indicates that the server understood the request, but it refuses to authorize it. The client may not have the necessary permissions to access the resource.

‍
JSON Example:

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "additionalProp1": "string",
  "additionalProp2": "string",
  "additionalProp3": "string"
}

‍

Not Found (404)

• This response indicates that the requested resource could not be found.

‍
JSON Example:

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "additionalProp1": "string",
  "additionalProp2": "string",
  "additionalProp3": "string"
}

‍

Server Error (500)

• This response indicates that there was an internal server error while processing the request.

‍
JSON Example:

{
  "error": "string"
}

‍