Interface Error

An error response including the code for the type of error and a human-readable message describing the error.

interface Error {
    correlationId?: string;
    errorLink?: string;
    errorMessage: string;
    errorType: ErrorType;
}

Properties

correlationId?: string

A unique identifier for the request that generated the error. This can be used to help debug issues with the API.

errorLink?: string

A link to the corresponding error documentation.

errorMessage: string

The error message.

errorType: ErrorType