Problem Details

Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by RFC7807.

{
    "type": "error:validation",
    "title": "Required value not specified.",
    "details": "The orgShortName value is required."
    "instance": "required_value_missing"
}
Name Description Type Always Present Example

type

A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

String

No

"error:validation"

title

A short, human-readable summary of the problem type.

String

No

"Required value not specified."

details

A human-readable explanation specific to this occurrence of the problem.

String

No

"The orgShortName value is required."

instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

String

No

"required_value_missing"