Interface APIError

Standardized response interface in REST API services for errors

interface APIError {
    code: string;
    detail?: string;
    links?: Links;
    meta?: { [x: string]: any };
    source?: APISource;
    status: number;
    title: string;
    uuid: string;
}

Properties

code detail? links? meta? source? status title uuid

Properties

code

code: string

REST API specific error code

Optionaldetail

detail?: string

Human-readable explanation specific to this occurrence of the problem

Optionallinks

links?: Links

Links that leads to further details about this particular occurrence of the problem. A link MUST be represented as either:

  • self: a string containing the link’s URL
  • related: an object (“link object”) which can contain the following members:
    • href: a string containing the link’s URL.
    • meta: a meta object containing non-standard meta-information about the link.

Optionalmeta

meta?: { [x: string]: any }

A meta object containing non-standard meta-information about the error

Optionalsource

source?: APISource

An object containing references to the source of the error

status

status: number

HTTP Status code

title

title: string

Human-readable summary of problem that SHOULD NOT change from occurrence to occurrence

uuid

uuid: string

UUID V4, unique identifier for this particular occurrence of the problem

Settings

Member Visibility

On This Page

Properties