Function MessagesApiFactory

Returns {
    getMessage(
        requestParameters: MessagesApiGetMessageRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<MessageSchema>;
    getMessagePatientrecords(
        requestParameters: MessagesApiGetMessagePatientrecordsRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<PatientRecordSummarySchema[]>;
    getMessages(
        requestParameters?: MessagesApiGetMessagesRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<PageMessageSchema>;
    getMessageSource(
        requestParameters: MessagesApiGetMessageSourceRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<MessageSourceSchema>;
    getMessageWorkitems(
        requestParameters: MessagesApiGetMessageWorkitemsRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<WorkItemSchema[]>;
}

• getMessage: function

  • getMessage(
        requestParameters: MessagesApiGetMessageRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<MessageSchema>

    Retreive detailed information about a specific error message

    Parameters

    • requestParameters: MessagesApiGetMessageRequest

      Request parameters.
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<MessageSchema>

    Throws

• getMessagePatientrecords: function

  • getMessagePatientrecords(
        requestParameters: MessagesApiGetMessagePatientrecordsRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<PatientRecordSummarySchema[]>

    Retreive patient records associated with a specific error message

    Parameters

    • requestParameters: MessagesApiGetMessagePatientrecordsRequest

      Request parameters.
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PatientRecordSummarySchema[]>

    Throws

• getMessages: function

  • getMessages(
        requestParameters?: MessagesApiGetMessagesRequest,
        options?: AxiosRequestConfig,
    ): 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

    • requestParameters: MessagesApiGetMessagesRequest = {}

      Request parameters.
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PageMessageSchema>

    Throws

• getMessageSource: function

  • getMessageSource(
        requestParameters: MessagesApiGetMessageSourceRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<MessageSourceSchema>

    Retreive detailed information about a specific error message

    Parameters

    • requestParameters: MessagesApiGetMessageSourceRequest

      Request parameters.
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<MessageSourceSchema>

    Throws

• getMessageWorkitems: function

  • getMessageWorkitems(
        requestParameters: MessagesApiGetMessageWorkitemsRequest,
        options?: AxiosRequestConfig,
    ): AxiosPromise<WorkItemSchema[]>

    Retreive WorkItems associated with a specific error message

    Parameters

    • requestParameters: MessagesApiGetMessageWorkitemsRequest

      Request parameters.
    • Optionaloptions: AxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<WorkItemSchema[]>

    Throws