Class ProblemDetails

A machine-readable format for specifying errors in HTTP API responses based on https://tools.ietf.org/html/rfc7807.

Implements

  • IProblemDetails

Constructors

constructor

Properties

detail? errorCode? errorSource? extensions? instance? operationId? status title? traceId? type?

Methods

init toJSON fromJS

Constructors

constructor

Properties

Optionaldetail

detail?: string

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

OptionalerrorCode

errorCode?: number

The error code.

OptionalerrorSource

errorSource?: string

The error source.

Optionalextensions

extensions?: any

A property that may contain additional info such as in the case of partial success responses.

Optionalinstance

instance?: string

A URI reference that identifies the specific occurrence of the problem.

OptionaloperationId

operationId?: string

The operation id.

status

status: number

The HTTP status code.

Optionaltitle

title?: string

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

OptionaltraceId

traceId?: string

The trace id.

Optionaltype

type?: string

The problem type.

Methods

init

  • init(_data?: any): void

    Parameters

    • Optional_data: any

    Returns void

toJSON

  • toJSON(data?: any): any

    Parameters

    • Optionaldata: any

    Returns any

StaticfromJS

Settings

Member Visibility

On This Page

Constructors
Properties
Methods