Options
All
  • Public
  • Public/Protected
  • All
Menu

Standardized response interface in REST API services for errors

Hierarchy

  • APIError

Index

Properties

code

code: string

REST API specific error code

Optional detail

detail?: string

Human-readable explanation specific to this occurrence of the problem

Optional 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.

Type declaration

  • [x: string]: string

Optional meta

meta?: {}

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

Type declaration

  • [x: string]: any

Optional source

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

Generated using TypeDoc