Type alias ErrorDetailBeta

ErrorDetail: {
    code?: string;
    detail: string;
    id?: string;
    meta?: Record<string, any>;
    source?: {
        header?: string;
        parameter?: string;
        pointer?: string;
    };
    status?: string;
    title?: string;
}

Error received from the PFI server response

Type declaration

  • Optional code?: string

    An application-specific error code, expressed as a string value.

  • detail: string

    A human-readable explanation specific to this occurrence of the problem.

  • Optional id?: string

    A unique identifier for this particular occurrence of the problem.

  • Optional meta?: Record<string, any>

    A meta object containing non-standard meta-information about the error.

  • Optional source?: {
        header?: string;
        parameter?: string;
        pointer?: string;
    }

    An object containing references to the source of the error.

    • Optional header?: string

      A string indicating the name of a single request header which caused the error.

    • Optional parameter?: string

      A string indicating which URI query parameter caused the error.

    • Optional pointer?: string

      A JSON Pointer to the value in the request document that caused the error.

  • Optional status?: string

    The HTTP status code applicable to this problem, expressed as a string value.

  • Optional title?: string

    A short, human-readable summary of the problem.

Settings

Member Visibility

Theme