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::GetTransport method | |||
---|---|---|---|
Returns the transport information that is the routing information going from a sender (from) over at least one intermediate (via) to the receiver (to). All the involved parties are defined by GLN as defined by Stiftung Refdata.
If the routing is requested over more than one intermediate, than the whole routing chain ('@'-separated) is returned in the variable 'pbstrViaEAN' . If the parameters for the signature and encryption were set then these data are returned as well otherwise the corresponding variables are empty. Note that the transport parameter chain is mirrored after the singularity point that is after calling IGeneralNotificationRequest::SetReply. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralNotificationResponse/GetTransport | ||
[JSON input data] | pIGeneralNotificationResponse: | longValue, //interface address |
|
[JSON result data] | pbstrFromEAN: pbstrViaEAN: pbstrToEAN: pbstrToBinDERFile: pbStatus: |
"utf8StringValue", "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. | ||
C/C++ calling syntax | |||
HRESULT GetTransport( | BSTR
BSTR BSTR BSTR VARIANT_BOOL |
*pbstrFromEAN,
*pbstrViaEAN, *pbstrToEAN, *pbstrToBinDERFile, *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 | *pbstrFromEAN | The EAN number of the sender as supplied by Stiftung Refdata | |
[out] BSTR | *pbstrViaEAN | The chain of intermediates supplied as '@'-separated string of GLN of the involved intermediates e.g. 'gln1@gln2'.
Each GLN is defined by Stiftung Refdata |
|
[out] BSTR | *pbstrToEAN | The EAN number of the receiver as supplied by Stiftung Refdata | |
[out] BSTR | *pbstrToBinDERFile | The file name of the binary DER certificate that is the public certificate of the "to" entity. | |
[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. | |