Function MessagesApiFp

Returns {
    getMessage(
        messageId: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MessageSchema>,
    >;
    getMessagePatientrecords(
        messageId: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PatientRecordSummarySchema[]>,
    >;
    getMessages(
        facility?: string | null,
        since?: string | null,
        until?: string | null,
        status?: string[] | null,
        channel?: string[] | null,
        ni?: string[] | null,
        page?: number,
        size?: number,
        sortBy?: MessageEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageMessageSchema>,
    >;
    getMessageSource(
        messageId: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MessageSourceSchema>,
    >;
    getMessageWorkitems(
        messageId: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<WorkItemSchema[]>,
    >;
}

• getMessage: function

  • getMessage(
        messageId: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MessageSchema>,
    >

    Retreive detailed information about a specific error message

    Parameters

    • messageId: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MessageSchema>,
    >

    Throws

• getMessagePatientrecords: function

  • getMessagePatientrecords(
        messageId: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PatientRecordSummarySchema[]>,
    >

    Retreive patient records associated with a specific error message

    Parameters

    • messageId: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PatientRecordSummarySchema[]>,
    >

    Throws

• getMessages: function

  • getMessages(
        facility?: string | null,
        since?: string | null,
        until?: string | null,
        status?: string[] | null,
        channel?: string[] | null,
        ni?: string[] | null,
        page?: number,
        size?: number,
        sortBy?: MessageEnum | null,
        orderBy?: OrderBy | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageMessageSchema>,
    >

    Retreive a list of error messages, optionally filtered by NI, facility, or date. By default returns message created within the last 365 days.

    Parameters

    • Optionalfacility: string | null
    • Optionalsince: string | null
    • Optionaluntil: string | null
    • Optionalstatus: string[] | null
    • Optionalchannel: string[] | null
    • Optionalni: string[] | null
    • Optionalpage: number

      Page number

    • Optionalsize: number

      Page size

    • OptionalsortBy: MessageEnum | null
    • OptionalorderBy: OrderBy | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageMessageSchema>,
    >

    Throws

• getMessageSource: function

  • getMessageSource(
        messageId: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MessageSourceSchema>,
    >

    Retreive detailed information about a specific error message

    Parameters

    • messageId: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<MessageSourceSchema>,
    >

    Throws

• getMessageWorkitems: function

  • getMessageWorkitems(
        messageId: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<WorkItemSchema[]>,
    >

    Retreive WorkItems associated with a specific error message

    Parameters

    • messageId: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<WorkItemSchema[]>,
    >

    Throws