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::GetDocuments method | |||
---|---|---|---|
This method has a Restful Webservice representation only! Method for collecting all document data covered by the IGeneralNotificationResponse interface and returned as JSON array. Please note that IGeneralNotificationResponse::GetDocuments takes over the functionality of the iterator pair IGeneralNotificationResponse::GetFirstDocument / IGeneralNotificationResponse::GetNextDocument with a single call, making the latter superfluous. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralNotificationResponse/GetDocuments | ||
[JSON input data] | pIGeneralNotificationResponse: | longValue, //interface address |
|
[JSON result array] | { pbstrFile: pbstrTitle: pbstrMimeType: pbStatus: |
"utf8StringValue", "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] BSTR | *pbstrFile | *pbstrFile supplies the full file name (path + name) of the document in a temporary working directory.
Be sure to copy away the file to a different location as all files in the working directory are deleted before the COM module shuts down! In Restful Webservice output: pbstrFile is a relative URL that subsequently must be downloaded by a GET process. |
|
[out] BSTR | *pbstrTitle | The title of the document on the primary system. It thus describes the document to a certain degree in terms of its semantic content. | |
[out] BSTR | *pbstrMimeType | The MIME type of the document.
Since the underlying XSD schema restricts the type of files, the MIME type must be one of
|
|
[out,retval] VARIANT_BOOL | *pbStatus | Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached | |