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
IGeneralNotificationRequest::SetNotification method | |||
---|---|---|---|
Sets the main notification object reference.
The dependent object references form a object reference chain with the notification 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/IGeneralNotificationRequest/SetNotification | ||
[JSON input data] | pIGeneralNotificationRequest: bstrNotificationID: dNotificationDate: lNotificationTimestamp: |
longValue, //interface address "utf8StringValue", variantDateValue | "stringISODateValue", longValue |
|
[JSON result data] | pbStatus: | 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 SetNotification( | BSTR
DATE long VARIANT_BOOL |
bstrNotificationID,
dNotificationDate, lNotificationTimestamp, *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 | |||
[in] BSTR | bstrNotificationID | The notification ID is the main software's ID of the notification.
This is one of 3 identifiers that constitute the notification object reference. |
|
[in] DATE | dNotificationDate | The notification date is the main software's date of the notification.
This is one of 3 identifiers that constitute the notification object reference. |
|
[in] long | lNotificationTimestamp | This is a UNIX timestamp defined at the moment of the notification's infoset generation.
Set this variable 0 to indicate the generation of a new notification object reference. The IGeneralNotificationManager::GetXML method will return the timestamp that must be used from that point on as 3rd parameter of the object reference.
This is one of 3 identifiers that constitute the notification object reference. The timestamp will be generated once for a certain notification object reference and thereafter the timestamp is always referenced |
|
[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. | |