MD

Error

canonical/error.md

Error

Purpose

An Error describes a condition that prevented all or part of a Call from being successfully processed.

Definition

An Error consists of:

- code — a machine-readable identifier describing the error.
- class — a stable category for handling the error.
- message — a human-readable description of the error.
- severity — optional. When the producing component has resolved how serious the Error is
for the response as a whole, one of notice (the response still stands; something
secondary did not) or error. Absent when the producer leaves that judgement to the
consumer.

Initial error classes are:

Notes

A Dataset may contain zero or more Errors.

The meaning of individual error codes is defined by the component that produces them.