API browser of hospitalMCDRequest452 COM module


/images/arrow_right.png IHospitalMCDRequest::SetTransport method space
Sets transport information that is the routing information going from a sender (from) over the first intermediate (via) to the receiver (to). All the involved parties are defined by GLN as defined by Stiftung Refdata.

This method allows to define the parameters needed for sign and/or encrypt the resulting XML infoset. Therefore, read the notes about signature and encryption to get familiar with these concepts.

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IHospitalMCDRequest/SetTransport
[JSON input data] pIHospitalMCDRequest:
bstrFromGLN:
bstrFromPFXFile:
bstrFromPFXPassword:
bstrViaGLN:
bstrToGLN:
bstrToBinDERFile:
longValue,    //interface address
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
"utf8StringValue",
"utf8StringValue"
[JSON result data] pbStatus: 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.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT SetTransport( BSTR
BSTR
BSTR
BSTR
BSTR
BSTR
VARIANT_BOOL
bstrFromGLN,
bstrFromPFXFile,
bstrFromPFXPassword,
bstrViaGLN,
bstrToGLN,
bstrToBinDERFile,
*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.
space
/images/arrow_right.png Calling argument description
[in] BSTR bstrFromGLN The GLN of the sender as supplied by Stiftung Refdata
[in] BSTR bstrFromPFXFile The file name of the PFX certificate that is the private certificate of the "from" entity.
If the variable is empty or NULL then no signature is applied otherwise a signature might be applied depending on the lXMLGenerationAttributes of the GetXML method.
[in] BSTR bstrFromPFXPassword The password to open the PFX certificate. The password is only used if a PFX certificate is supplied.
[in] BSTR bstrViaGLN The GLN of the first intermediate as supplied by Stiftung Refdata
[in] BSTR bstrToGLN The GLN of the recipient as supplied by Stiftung Refdata
[in] BSTR bstrToBinDERFile The file name of the binary DER certificate that is the public certificate of the "to" entity.
If the variable is empty or NULL then no encryption is applied otherwise encryption might be applied depending on the lXMLGenerationAttributes of the GetXML
[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.
space