The generalCreditRequest ATL COM module for
generating electronic and paper based credit requests
generating electronic and paper based credit requests
API browser of generalCreditRequest450 COM module
IGeneralCreditResult::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 numbers as defined by Stiftung Refdata.
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/IGeneralCreditResult/GetTransport | ||
[JSON input data] | pIGeneralCreditResult: | longValue, //interface address |
|
[JSON result data] | pbstrFromEAN: pbstrFromPFXFile: pbstrFromPFXPassword: pbstrViaEAN: pbstrToEAN: pbstrToBinDERFile: pbStatus: |
"utf8StringValue", "utf8StringValue", "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 BSTR BSTR VARIANT_BOOL |
*pbstrFromEAN,
*pbstrFromPFXFile, *pbstrFromPFXPassword, *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 GLN (former EAN) number of the sender as supplied by Stiftung Refdata | |
[out] BSTR | *pbstrFromPFXFile | The file name of the PFX certificate used for signing that is the private certificate of the "from" entity.
If the request is not signed than this parameter is empty |
|
[out] BSTR | *pbstrFromPFXPassword | The password to open the PFX certificate.
If the request is not signed than this parameter is empty |
|
[out] BSTR | *pbstrViaEAN | The GLN (former EAN) number of the first intermediate as supplied by Stiftung Refdata | |
[out] BSTR | *pbstrToEAN | The GLN (former EAN) number of the receiver as supplied by Stiftung Refdata | |
[out] BSTR | *pbstrToBinDERFile | The file name of the binary DER certificate used for encryption 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. | |