Interface ApiXErrorResponse

An interface representing an error returned by the API-X service.

interface ApiXErrorResponse {
    error: ApiXErrorInfo;
    message?: string;
    success: false;
}

Properties

The error object containing details about the error.

Available after API-X v2.1.x.

message?: string

An optional message providing additional information about the error.

This field is deprecated and will be removed in future versions. Use the error object instead.

success: false

A Boolean value indicating whether the request was successful. This will always be false for an error response.