|
|
| Rad 1: |
Rad 1: |
| − | ; ID (optional)
| |
| − | : A unique identifier for this particular occurrence of the problem. Can be used if the error is logged to improve troubleshooting.
| |
| | | | |
| − | ; STATUS (optional)
| |
| − | : The HTTP status code applicable to this problem.
| |
| − |
| |
| − | ; CODE (required)
| |
| − | : An application-specific error code. The meaning can be internal or public depending on sensitivity. Facilitates troubleshooting. Sensitive information can be hidden behind a code. Localization of error messages can be done through this code.
| |
| − |
| |
| − | ; PUBLIC (optional)
| |
| − | : A boolean indicating if TITLE and DETAIL can be shown to end users. It SHOULD be present if either TITLE or DETAIL is provided.
| |
| − |
| |
| − | ; TITLE (optional)
| |
| − | : A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
| |
| − |
| |
| − | ; DETAIL (optional)
| |
| − | : A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized.
| |
| − |
| |
| − | ; SOURCE (optional)
| |
| − | : An object containing references to the primary source of the error. It SHOULD include one of its properties or be omitted. Useful when troubleshooting or showing validation errors.
| |
| − |
| |
| − | :; POINTER
| |
| − | :: A JSON Pointer [RFC6901] to the value in the request document that caused the error.
| |
| − |
| |
| − | :; PARAMETER
| |
| − | :: A string indicating which URI query parameter caused the error.
| |
| − |
| |
| − | :; HEADER
| |
| − | :: A string indicating the name of a single request header which caused the error.
| |
