Function MessagesApiFp

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

• getMessage: function

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

    Retreive detailed information about a specific error message

    Parameters

    • messageId: number
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

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

    Throws

• getMessagePatientrecords: function

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

    Retreive patient records associated with a specific error message

    Parameters

    • messageId: number
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

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

    Throws

• getMessages: function

  • getMessages(
        facility?: string,
        since?: string,
        until?: string,
        status?: string[],
        channel?: string[],
        ni?: string[],
        sortBy?: MessageEnum,
        orderBy?: OrderBy,
        page?: number,
        size?: number,
        options?: AxiosRequestConfig,
    ): 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
    • Optionalsince: string
    • Optionaluntil: string
    • Optionalstatus: string[]
    • Optionalchannel: string[]
    • Optionalni: string[]
    • OptionalsortBy: MessageEnum
    • OptionalorderBy: OrderBy
    • Optionalpage: number
    • Optionalsize: number
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

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

    Throws

• getMessageSource: function

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

    Retreive detailed information about a specific error message

    Parameters

    • messageId: number
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

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

    Throws

• getMessageWorkitems: function

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

    Retreive WorkItems associated with a specific error message

    Parameters

    • messageId: number
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

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

    Throws