Skip to main content

ProblemDetailsViewModel

Describes a problem that occurred whilst processing the request. The format is based on RFC7807.

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
status integer true

The HTTP status code generated by the origin server for the problem.
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.

Example schema

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "detail": "More detail about the problem.",
  "instance": "https://example.com",
  "<*>": {
  }
}