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::GetFirstMessage method | |||
---|---|---|---|
Retrieves the first notification message. VARIANT_FALSE is returned if the end of the message list is reached.
Note that the very first message is the most recent one, any following message is older by one message exchange hop. Therefore, the message iterator forms a serialized message historization. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralNotificationResponse/GetFirstMessage | ||
[JSON input data] | pIGeneralNotificationResponse: | longValue, //interface address |
|
[JSON result data] | 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. | ||
C/C++ calling syntax | |||
HRESULT GetFirstMessage( | BSTR
BSTR DATE VARIANT_BOOL |
*pbstrMessage,
*pbstrFormOID, *pdMessageDate, *pbStatus); |
|
[C/C++ return value] | S_OK | This value is returned if the function call was successful. | |
S_FALSE | This value is returned if the end of an iteration is reached | ||
E_name | This value is returned if the function call was unsuccessful and an error exception was generated. Note that if you are using SmartPointers an exception is thrown under these conditions. | ||
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 | |