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::GetInstructions method | |||
---|---|---|---|
This method has a Restful Webservice representation only! Method for collecting all instruction data covered by the IGeneralNotificationResponse interface and returned as JSON array. Please note that IGeneralNotificationResponse::GetInstructions takes over the functionality of the iterator pair IGeneralNotificationResponse::GetFirstInstruction / IGeneralNotificationResponse::GetNextInstruction with a single call, making the latter superfluous. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralNotificationResponse/GetInstructions | ||
[JSON input data] | pIGeneralNotificationResponse: | longValue, //interface address |
|
[JSON result array] | { plGroupNumber: pbstrToken: pbstrValue: pbStatus: |
longValue, "utf8StringValue", "utf8StringValue", 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] long | *plGroupNumber | The lGroupNumber allows to further group the instruction set by a group numbering scheme.
Note that the instructions are returned in the same sequence as the input was done. Therefore, the grouping into equal instructions must be done outside the COM module. |
|
[out] BSTR | *pbstrToken | The token part of the token/value formatted instruction | |
[out] BSTR | *pbstrValue | The value part of the token/value formatted instruction | |
[out,retval] VARIANT_BOOL | *pbStatus | Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached | |