Class MessagesApi

MessagesApi - object-oriented interface

Export

MessagesApi

Hierarchy

BaseAPI
- MessagesApi

Index

Constructors

constructor

new MessagesApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): MessagesApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns MessagesApi
Inherited from BaseAPI.constructor
- Defined in base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration

Methods

getMessage

getMessage(
requestParameters: MessagesApiGetMessageRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<MessageSchema, any>>
Retreive detailed information about a specific error message
Parameters
- requestParameters: MessagesApiGetMessageRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<MessageSchema, any>>
Throws
Memberof
MessagesApi
- Defined in api.ts:11497

getMessagePatientrecords

getMessagePatientrecords(
requestParameters: MessagesApiGetMessagePatientrecordsRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<PatientRecordSummarySchema[], any>>
Retreive patient records associated with a specific error message
Parameters
- requestParameters: MessagesApiGetMessagePatientrecordsRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PatientRecordSummarySchema[], any>>
Throws
Memberof
MessagesApi
- Defined in api.ts:11509

getMessages

getMessages(
requestParameters?: MessagesApiGetMessagesRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<PageMessageSchema, any>>
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 Promise<AxiosResponse<PageMessageSchema, any>>
Throws
Memberof
MessagesApi
- Defined in api.ts:11545

getMessageSource

getMessageSource(
requestParameters: MessagesApiGetMessageSourceRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<MessageSourceSchema, any>>
Retreive detailed information about a specific error message
Parameters
- requestParameters: MessagesApiGetMessageSourceRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<MessageSourceSchema, any>>
Throws
Memberof
MessagesApi
- Defined in api.ts:11521

getMessageWorkitems

getMessageWorkitems(
requestParameters: MessagesApiGetMessageWorkitemsRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<WorkItemSchema[], any>>
Retreive WorkItems associated with a specific error message
Parameters
- requestParameters: MessagesApiGetMessageWorkitemsRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<WorkItemSchema[], any>>
Throws
Memberof
MessagesApi
- Defined in api.ts:11533

Class MessagesApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MessagesApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

getMessage

Parameters

Returns Promise<AxiosResponse<MessageSchema, any>>

Throws

Memberof

getMessagePatientrecords

Parameters

Returns Promise<AxiosResponse<PatientRecordSummarySchema[], any>>

Throws

Memberof

getMessages

Parameters

Returns Promise<AxiosResponse<PageMessageSchema, any>>

Throws

Memberof

getMessageSource

Parameters

Returns Promise<AxiosResponse<MessageSourceSchema, any>>

Throws

Memberof

getMessageWorkitems

Parameters

Returns Promise<AxiosResponse<WorkItemSchema[], any>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration