Interface IProblemDetails

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

interface IProblemDetails {
    detail?: string;
    errorCode?: number;
    errorSource?: string;
    instance?: string;
    operationId?: string;
    status: number;
    title?: string;
    traceId?: string;
    type?: string;
    [key: string]: any;
}

Implemented by

Indexable

  • [key: string]: any

Properties

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

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.

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.

Settings

Member Visibility

On This Page

Properties