ValidationProblemViewModel

A validation problem that has occurred with the API request. This type of response will be composed of one or more errors relating to the request and its properties.

Properties

Property	Type	Required	Description
type	string	true	A URI reference (RFC3986) that identifies the problem type. It should provide human-readable documentation for the problem type. Validation constraints: Minimum length: 1
title	string	true	A short, human-readable summary of the problem type. Validation constraints: Minimum length: 1
detail	string	false	A human-readable explanation specific to the problem.
instance	string	false	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information about the problem.
status	integer	false	The HTTP status code generated by the origin server for the problem.
errors	array (ErrorViewModel)	false	The errors relating to the validation problem.

Example schema

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "One or more validation errors occurred.",
  "detail": "More detail about the problem.",
  "instance": "https://example.com",
  "status": 400,
  "errors": [
    {
      "message": "Must be 50 characters or fewer.",
      "path": "person.name",
      "code": "MaximumLength",
      "detail": {
        "maxLength": 50
      }
    }
  ],
  "<*>": {
  }
}