Package version:

Interface ErrorResponse

See the official documentation for more details:

NOTE: This documentation is for v1 OAuth support but the same error response details still apply to v2.

interface ErrorResponse {
    correlationId?: string;
    error: string;
    errorCodes?: {};
    errorDescription: string;
    timestamp?: string;
    traceId?: string;
}

Properties

correlationId?: string

The correlation ID to be used for tracking the source of the error.

error: string

The string identifier for the error.

errorCodes?: {}

An array of codes pertaining to the error(s) that occurred.

errorDescription: string

The error's description.

timestamp?: string

The timestamp at which the error occurred.

traceId?: string

The trace identifier for this error occurrence.