The ATL COM module generalInvoiceRequest is capable of
generating electronic and printed invoices & reminders
API browser of generalInvoiceRequest500 COM module


/images/arrow_right.png IGeneralInvoiceRequest::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 numbers as defined by Stiftung Refdata.
 
Furthermore, the underlaying standard generalInvoiceRequest500 defines 2 very special, semantically loaded GLN, that can be used for special routing.
  • <attribute name='define_gln_printcenter' type='invoice:glnPartyType' fixed='2005555555003'/>
    The 'printCenterGLN'='2005555555003' used as to variable forces a printout at the print center of the intermediate no matter what other parameters of the XML infoset are!
     
    Conversely, please note that if an unknown GLN (not the printCenterGLN) is used in a TG case, this will result in a rejection due to unclear routing - there is no automatic printout!
     
  • <attribute name='define_gln_norecipient' type='invoice:glnPartyType' fixed='2006666666008'/>
    The 'noRecipientGLN'='2006666666008' used as to variable forces a deletion of this primary process at the intermediate after all secondary processes are satiesfied.
    These secondary processes are:
    • sending a patient copy to the guarantor if ePrintCopyToGuarantor=enYes in IGeneralInvoiceRequest::SetProcessing() of a TP case!
    • sending the current XML infoset to the designated TrustCenter if bstrTrustCenterGLN='gln' in IGeneralInvoiceRequest::SetProcessing(). Such an action is neccessary for a storno XML that is signaled
      to the TrustCenter but not to the primary recipient (because the storno is due to a rejected XML).
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralInvoiceRequest/SetTransport
[JSON input data] pIGeneralInvoiceRequest:
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 receiver as supplied by Stiftung Refdata
  • bstrToGLN='2005555555003' forces routing to the print center (mnemonic 'printCenterGLN')
  • bstrToGLN='2006666666008' forces routing to /dev/null aka deletion (mnemonic 'noRecipientGLN')
[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