(Excel) BaFin MVP Portal SOAP Web Service MTOM

Demonstrate how to send a SOAP request with MTOM attachment to the BaFin MVP Portal as indicated at https://www.bafin.de/SharedDocs/Downloads/EN/dl_mvp-portal_soap_webservice_a26mifir_en.pdf

For more information, see https://www.bafin.de/SharedDocs/Downloads/EN/dl_mvp-portal_soap_webservice_a26mifir_en.pdf

Download Excel Class Modules Chilkat Excel Class Modules

' This example requires the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim rest As Chilkat.Rest
Set rest = Chilkat.NewRest

' Connect to portal.mvp.bafin.de:444

bTls = True

port = 444

bAutoReconnect = True

success = rest.Connect("portal.mvp.bafin.de",port,bTls,bAutoReconnect)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

' The SOAP request we'll be sending is multipart/related and it will have two parts
' 1) the SOAP Envelope
' 2) the MTOM attachment (in this case an XML document)

' Let's build the SOAP envelope:
' Note: The data posted here, including the username, are not actual accounts.  It is the sample data provided
' at https://www.bafin.de/SharedDocs/Downloads/EN/dl_mvp-portal_soap_webservice_a26mifir_en.pdf

' Use this online tool to generate code from sample XML: 
' Generate Code to Create XML

Dim soapXml As Chilkat.Xml
Set soapXml = Chilkat.NewXml
soapXml.Tag = "soapenv:Envelope"
Dim success As Boolean
success = soapXml.AddAttribute("xmlns:a26mifir","http://www.bafin.de/mvp/a26mifir/")
success = soapXml.AddAttribute("xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/")
success = soapXml.UpdateAttrAt("soapenv:Header|wsse:Security",True,"soapenv:mustUnderstand","1")
success = soapXml.UpdateAttrAt("soapenv:Header|wsse:Security",True,"xmlns:wsse","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd")
success = soapXml.UpdateAttrAt("soapenv:Header|wsse:Security",True,"xmlns:wsu","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurityutility-1.0.xsd")
success = soapXml.UpdateAttrAt("soapenv:Header|wsse:Security|wsse:UsernameToken",True,"wsu:Id","UsernameToken44C3662D584567FE6A14672949268541")
soapXml.UpdateChildContent "soapenv:Header|wsse:Security|wsse:UsernameToken|wsse:Username","karl.meier1234#hg_05_1234567890"
success = soapXml.UpdateAttrAt("soapenv:Header|wsse:Security|wsse:UsernameToken|wsse:Password",True,"Type","http://docs.oasis-open.org/wss/2004/01/oasis200401-wss-username-token-profile-1.0#PasswordText")
soapXml.UpdateChildContent "soapenv:Header|wsse:Security|wsse:UsernameToken|wsse:Password","XXXXXXXXXX"
success = soapXml.UpdateAttrAt("soapenv:Header|wsse:Security|wsse:UsernameToken|wsse:Nonce",True,"EncodingType","http://docs.oasis-open.org/wss/2004/01/oasis200401-wss-soap-message-security1.0#Base64Binary")
soapXml.UpdateChildContent "soapenv:Header|wsse:Security|wsse:UsernameToken|wsse:Nonce","+WifMh5kFw/1fHgMahFu7A=="
soapXml.UpdateChildContent "soapenv:Header|wsse:Security|wsse:UsernameToken|wsu:Created","2016-06-30T13:55:26.852Z"
soapXml.UpdateChildContent "soapenv:Body|a26mifir:submitDATTRA|inDATTRA|a26mifir:dateiname","A26MiFIR_Testfile_001.xml"
soapXml.UpdateChildContent "soapenv:Body|a26mifir:submitDATTRA|kundenreferenz","ClientRef_001"
success = soapXml.UpdateAttrAt("soapenv:Body|a26mifir:submitDATTRA|datei|inc:Include",True,"href","cid:139580394822")
success = soapXml.UpdateAttrAt("soapenv:Body|a26mifir:submitDATTRA|datei|inc:Include",True,"xmlns:inc","http://www.w3.org/2004/08/xop/include")

' We built the following XML:

' <?xml version="1.0" encoding="utf-8"?>
' <soapenv:Envelope xmlns:a26mifir="http://www.bafin.de/mvp/a26mifir/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
'     <soapenv:Header>
'         <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurityutility-1.0.xsd">
'             <wsse:UsernameToken wsu:Id="UsernameToken44C3662D584567FE6A14672949268541">
'                 <wsse:Username>karl.meier1234#hg_05_1234567890</wsse:Username>
'                 <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis200401-wss-username-token-profile-1.0#PasswordText">XXXXXXXXXX</wsse:Password>
'                 <wsse:Nonce EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis200401-wss-soap-message-security1.0#Base64Binary">+WifMh5kFw/1fHgMahFu7A==</wsse:Nonce>
'                 <wsu:Created>2016-06-30T13:55:26.852Z</wsu:Created>
'             </wsse:UsernameToken>
'         </wsse:Security>
'     </soapenv:Header>
'     <soapenv:Body>
'         <a26mifir:submitDATTRA>
'             <inDATTRA>
'                 <a26mifir:dateiname>A26MiFIR_Testfile_001.xml</a26mifir:dateiname>
'             </inDATTRA>
'             <kundenreferenz>ClientRef_001</kundenreferenz>
'             <datei>
'                 <inc:Include href="cid:139580394822" xmlns:inc="http://www.w3.org/2004/08/xop/include"/>
'             </datei>
'         </a26mifir:submitDATTRA>
'     </soapenv:Body>
' </soapenv:Envelope>

' ------------------------------------------------------------
' We want the top-most header of our request to look like this:

' POST https://portal.mvp.bafin.de:444/services/ws/t_a26mifir HTTP/1.1
' Content-Encoding: gzip
' Accept-Encoding: gzip,deflate
' Content-Type: multipart/related; type="application/xop+xml";
'    start="<rootpart@soapui.org>"; start-info="text/xml"; boundary="----=_Part_3_19706996.1467294979823"
' SOAPAction: "http://www.bafin.de/mvp/a26mifir/submitDATTRA"
' MIME-Version: 1.0
' Transfer-Encoding: chunked
' Host: portal.mvp.bafin.de:444
' Connection: Keep-Alive
' User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

' Some header fields are unimportant.  
' 1) We can omit the User-Agent.
' 2) Also, the Transfer-Encoding doesn't need to be "chunked".  It shouldn't matter whether it's chunked or non-chunked.
' 3) We do need the Content-Encoding to be "gzip", because the documentation at https://www.bafin.de/SharedDocs/Downloads/EN/dl_mvp-portal_soap_webservice_a26mifir_en.pdf
' explicitly states that it wants a gzip compressed request body.
' 4) Don't worry about specifying a boundary.  Chilkat will auto-generate a boundary and add it to the Content-Type.
' 5) If we're sending many requests on the same connection, then set the Connection: Keep-Alive header.  Otherwise, there is no need for it.

' Begin specifying header fields for the topmost header:
success = rest.AddHeader("Content-Type","multipart/related; type=""application/xop+xml""; start=""<rootpart@soapui.org>""; start-info=""text/xml""")
success = rest.AddHeader("Content-Encoding","gzip")
success = rest.AddHeader("Accept-Encoding","gzip,deflate")
success = rest.AddHeader("SOAPAction","http://www.bafin.de/mvp/a26mifir/submitDATTRA")
success = rest.AddHeader("MIME-Version","1.0")
success = rest.AddHeader("Connection","Keep-Alive")

' ------------------------------------------------------------
' Build the header for the 1st sub-part, which will contain the SOAP envelope.
' It will look like this:

' Content-Type: application/xop+xml; charset=UTF-8; type="text/xml"
' Content-Transfer-Encoding: 8bit
' Content-ID: <rootpart@soapui.org>

rest.PartSelector = "1"
success = rest.AddHeader("Content-Type","application/xop+xml; charset=UTF-8; type=""text/xml""")
success = rest.AddHeader("Content-Transfer-Encoding","8bit")
success = rest.AddHeader("Content-ID","<rootpart@soapui.org>")
soapXml.EmitCompact = True
soapXml.EmitXmlDecl = False
success = rest.SetMultipartBodyString(soapXml.GetXml())

' ------------------------------------------------------------
' Build the header for the 1st sub-part, which will contain the SOAP envelope.
' It will look like this:

' Content-Type: application/octet-binary; name=A26MiFIR_Testfile_001.xml
' Content-Transfer-Encoding: binary
' Content-ID: <139580394822>
' Content-Disposition: attachment; name=" A26MiFIR_Testfile_001.xml"; filename="A26MiFIR_Testfile_001.xml"

rest.PartSelector = "2"
success = rest.AddHeader("Content-Type","application/octet-binary; name=A26MiFIR_Testfile_001.xml")
success = rest.AddHeader("Content-Transfer-Encoding","binary")
success = rest.AddHeader("Content-ID","<139580394822>")
success = rest.AddHeader("Content-Disposition","attachment; name=""A26MiFIR_Testfile_001.xml""; filename=""A26MiFIR_Testfile_001.xml""")

' We'll just use a fake attachment XML body for this example
success = rest.SetMultipartBodyString("<test>blah blah blah</test>")

' ------------------------------------------------------------
' The request is fully specified.  Now send the POST...

' Turn on DebugMode.  This is a mode where no request is sent.  Instead, the request that would've been
' sent is recorded and can be retrieved via the GetLastDebugRequest method.
rest.DebugMode = True


responseBody = rest.FullRequestMultipart("POST","/services/ws/t_a26mifir")
If (rest.LastMethodSuccess <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

' Because we set DebugMode, no request was actually sent.  Instead, we can examine the exact
' request that would've been sent:
If (rest.DebugMode = True) Then
    Dim bdRequest As Chilkat.BinData
    Set bdRequest = Chilkat.NewBinData
    success = rest.GetLastDebugRequest(bdRequest)
    success = bdRequest.WriteFile("qa_output/bafin_request.txt")
End If

Debug.Print "Success."

' Clear the REST object for any subsequent requests..
success = rest.ClearAllHeaders()
success = rest.ClearAllParts()
rest.PartSelector = ""