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::GetNotification method | |||
---|---|---|---|
Retrieves the main notification object reference parameters.
The dependent object references (if supplied in the request) form a object reference chain with this notification object as topmost object reference. The page "object reference" provides an in-depth description of the concepts of "object reference", "object reference chain", and "topmost object reference". |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralNotificationResponse/GetNotification | ||
[JSON input data] | pIGeneralNotificationResponse: | longValue, //interface address |
|
[JSON result data] | pbstrNotificationID: pdNotificationDate: plNotificationTimestamp: pbStatus: |
"utf8StringValue", "stringISODateValue", longValue, 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 GetNotification( | BSTR
DATE long VARIANT_BOOL |
*pbstrNotificationID,
*pdNotificationDate, *plNotificationTimestamp, *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 | *pbstrNotificationID | The notification ID is the main software's identification of the notification.
This is one of 3 identifiers that form the notification object reference. |
|
[out] DATE | *pdNotificationDate | The notification date is the main software's date of the notification.
This is one of 3 identifiers that form the notification object reference. |
|
[out] long | *plNotificationTimestamp | This is a UNIX timestamp defined at the moment of the notification's infoset generation.
This is one of 3 identifiers that form the notification object reference. |
|
[out,retval] VARIANT_BOOL | *pbStatus | Return status of the method. If pbStatus is VARIANT_FALSE then an error occurred and GetAbortInfo should be called to retrieve the error string. | |