The ATL COM module generalNotification is a structured
message exchange protocol between to healthcare partners
message exchange protocol between to healthcare partners
API browser of generalnotification451 COM module
IGeneralNotificationResponse::GetMessages method | |||
---|---|---|---|
This method has a Restful Webservice representation only! Method for collecting all message data covered by the IGeneralNotificationResponse interface and returned as JSON array. Please note that IGeneralNotificationResponse::GetMessages takes over the functionality of the iterator pair IGeneralNotificationResponse::GetFirstMessage / IGeneralNotificationResponse::GetNextMessage with a single call, making the latter superfluous. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralNotificationResponse/GetMessages | ||
[JSON input data] | pIGeneralNotificationResponse: | longValue, //interface address |
|
[JSON result array] | { pbstrMessage: pbstrFormOID: pdMessageDate: pbStatus: |
"utf8StringValue", "utf8StringValue", "stringISODateValue", booleanValue }, |
|
[HTTP result status] | 200 | Return status 200 signals a successful method call | |
204 | Return status 204 (noContent) signals that the end of an iteration is reached | ||
>= 400 | Return status >= 400 signals an unsuccessful function call. The returned JSON{errorCode: code, errorText:"text"} supplies the error message the same as GetAbortInfo() would do. | ||
Calling argument description | |||
[out] BSTR | *pbstrMessage | The most recent message. | |
[out] BSTR | *pbstrFormOID | An optional OID of a PDF form.
If this form OID is set then this signals to start a form process using the GeneralFormRequestManager450 COM module and thereby generating a generalFormRequest_450.xsd based XML infoset. The sender, receiver, and reference object should be copied and the given form OID used as PDF template. |
|
[out] DATE | *pdMessageDate | The date when the most recent message was generated. | |
[out,retval] VARIANT_BOOL | *pbStatus | Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached | |