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::AddInstruction method | |||
---|---|---|---|
Adds an automation instruction to the list of instructions. The instruction is formatted as a token/value pair
Note that these instructions are defined purely between sender and receiver regarding the semantic meaning. The infoset is just the transport container.
|
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralNotificationRequest/AddInstruction | ||
[JSON input data] | pIGeneralNotificationRequest: lGroupNumber: bstrToken: bstrValue: |
longValue, //interface address longValue, "utf8StringValue", "utf8StringValue" |
|
[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 AddInstruction( | long
BSTR BSTR VARIANT_BOOL |
lGroupNumber,
bstrToken, bstrValue, *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] long | lGroupNumber | The lGroupNumber allows to further group the instruction set by a group numbering scheme. | |
[in] BSTR | bstrToken | The token part of the token/value formatted instruction | |
[in] BSTR | bstrValue | The value part of a token/value formatted instruction | |
[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. | |