Interface ErrorResponse

If an error occurs, the response will be an ErrorResponse.

400 - Bad Request (e.g. invalid request body) 401 - Unauthorized 500 - Internal Server Error

interface ErrorResponse {
    error?: string;
    errorMessage: string;
    unauthorized?: boolean;
}

Properties

error?: string

Serialized error object for debugging purposes. Technical users can use this to debug issues.

errorMessage: string

UX-friendly error message that can be displayed to the user. Always present if error.

unauthorized?: boolean

Authentication error. Present if the user is not authenticated.