and fills out a PDF based form system
 IGeneralFormResponse::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 EAN numbers as defined by Stiftung Refdata.
In fact the meaning and the data is mirrored from the corresponding request thus the initial sender becomes the recipient and the initial recipient becomes the sender. Furthermore the chain of intermediates from the request is reversed and the infoset is sent to the first intermediate of the reversed list. The given intermediate here is therefore the last one before reaching the receiver. If the parameters for the signature and encryption were set then these data are returned as well otherwise the corresponding variables are empty. |
|||
| |||
| Restful webservice calling syntax |
|||
| [POST] | /baseURL/IGeneralFormResponse/GetTransport | ||
| [JSON input data] | pIGeneralFormResponse: | 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 medwin.ch
Note that this is the initial receiver of the request since the transport information from the request is mirrored in the response |
|
| [out] BSTR | *pbstrViaEAN | The EAN number of the sender as supplied by Stiftung Refdata
Note that this is the initial receiver of the request since the transport information from the request is mirrored in the response |
|
| [out] BSTR | *pbstrToEAN | The EAN number of the last intermediate as supplied by Stiftung Refdata
Note that this is the initial (first) intermediate of the request since the transport information from the request is mirrored in the response |
|
| [out] BSTR | *pbstrToBinDERFile | The EAN number of the receiver as supplied by Stiftung Refdata
Note that this is the initial sender of the request since the transport information from the request is mirrored in the response |
|
| [out,retval] VARIANT_BOOL | *pbStatus | If the XML infoset was signed then bstrToBinDERFile is a full file name (path + name) to the extracted binary DER certificate that is the public certificate of the "from" entity. The certificate file is named X509DER_FromEAN.cer and must be copied away since the used temporary directory is emptied when the module shuts down.
Note that this certificate can be used to encrypt a request XML infoset for the "from" entity. |
|
|
|||