Sample code for 30+ languages & platforms
C

BaFin MVP Portal SOAP Web Service MTOM

See more REST Misc Examples

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

Chilkat C Downloads

C
#include <C_CkRest.h>
#include <C_CkXml.h>
#include <C_CkBinData.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkRest rest;
    BOOL bTls;
    int port;
    BOOL bAutoReconnect;
    HCkXml soapXml;
    const char *responseBody;
    HCkBinData bdRequest;

    success = FALSE;

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

    rest = CkRest_Create();

    // Connect to portal.mvp.bafin.de:444
    bTls = TRUE;
    port = 444;
    bAutoReconnect = TRUE;
    success = CkRest_Connect(rest,"portal.mvp.bafin.de",port,bTls,bAutoReconnect);
    if (success != TRUE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        return;
    }

    // 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

    soapXml = CkXml_Create();
    CkXml_putTag(soapXml,"soapenv:Envelope");
    CkXml_AddAttribute(soapXml,"xmlns:a26mifir","http://www.bafin.de/mvp/a26mifir/");
    CkXml_AddAttribute(soapXml,"xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/");
    CkXml_UpdateAttrAt(soapXml,"soapenv:Header|wsse:Security",TRUE,"soapenv:mustUnderstand","1");
    CkXml_UpdateAttrAt(soapXml,"soapenv:Header|wsse:Security",TRUE,"xmlns:wsse","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd");
    CkXml_UpdateAttrAt(soapXml,"soapenv:Header|wsse:Security",TRUE,"xmlns:wsu","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurityutility-1.0.xsd");
    CkXml_UpdateAttrAt(soapXml,"soapenv:Header|wsse:Security|wsse:UsernameToken",TRUE,"wsu:Id","UsernameToken44C3662D584567FE6A14672949268541");
    CkXml_UpdateChildContent(soapXml,"soapenv:Header|wsse:Security|wsse:UsernameToken|wsse:Username","karl.meier1234#hg_05_1234567890");
    CkXml_UpdateAttrAt(soapXml,"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");
    CkXml_UpdateChildContent(soapXml,"soapenv:Header|wsse:Security|wsse:UsernameToken|wsse:Password","XXXXXXXXXX");
    CkXml_UpdateAttrAt(soapXml,"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");
    CkXml_UpdateChildContent(soapXml,"soapenv:Header|wsse:Security|wsse:UsernameToken|wsse:Nonce","+WifMh5kFw/1fHgMahFu7A==");
    CkXml_UpdateChildContent(soapXml,"soapenv:Header|wsse:Security|wsse:UsernameToken|wsu:Created","2016-06-30T13:55:26.852Z");
    CkXml_UpdateChildContent(soapXml,"soapenv:Body|a26mifir:submitDATTRA|inDATTRA|a26mifir:dateiname","A26MiFIR_Testfile_001.xml");
    CkXml_UpdateChildContent(soapXml,"soapenv:Body|a26mifir:submitDATTRA|kundenreferenz","ClientRef_001");
    CkXml_UpdateAttrAt(soapXml,"soapenv:Body|a26mifir:submitDATTRA|datei|inc:Include",TRUE,"href","cid:139580394822");
    CkXml_UpdateAttrAt(soapXml,"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:
    CkRest_AddHeader(rest,"Content-Type","multipart/related; type=\"application/xop+xml\"; start=\"<rootpart@soapui.org>\"; start-info=\"text/xml\"");
    CkRest_AddHeader(rest,"Content-Encoding","gzip");
    CkRest_AddHeader(rest,"Accept-Encoding","gzip,deflate");
    CkRest_AddHeader(rest,"SOAPAction","http://www.bafin.de/mvp/a26mifir/submitDATTRA");
    CkRest_AddHeader(rest,"MIME-Version","1.0");
    CkRest_AddHeader(rest,"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>

    CkRest_putPartSelector(rest,"1");
    CkRest_AddHeader(rest,"Content-Type","application/xop+xml; charset=UTF-8; type=\"text/xml\"");
    CkRest_AddHeader(rest,"Content-Transfer-Encoding","8bit");
    CkRest_AddHeader(rest,"Content-ID","<rootpart@soapui.org>");
    CkXml_putEmitCompact(soapXml,TRUE);
    CkXml_putEmitXmlDecl(soapXml,FALSE);
    CkRest_SetMultipartBodyString(rest,CkXml_getXml(soapXml));

    // ------------------------------------------------------------
    // 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"

    CkRest_putPartSelector(rest,"2");
    CkRest_AddHeader(rest,"Content-Type","application/octet-binary; name=A26MiFIR_Testfile_001.xml");
    CkRest_AddHeader(rest,"Content-Transfer-Encoding","binary");
    CkRest_AddHeader(rest,"Content-ID","<139580394822>");
    CkRest_AddHeader(rest,"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
    CkRest_SetMultipartBodyString(rest,"<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.
    CkRest_putDebugMode(rest,TRUE);

    responseBody = CkRest_fullRequestMultipart(rest,"POST","/services/ws/t_a26mifir");
    if (CkRest_getLastMethodSuccess(rest) != TRUE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        CkXml_Dispose(soapXml);
        return;
    }

    // Because we set DebugMode, no request was actually sent.  Instead, we can examine the exact
    // request that would've been sent:
    if (CkRest_getDebugMode(rest) == TRUE) {
        bdRequest = CkBinData_Create();
        success = CkRest_GetLastDebugRequest(rest,bdRequest);
        success = CkBinData_WriteFile(bdRequest,"qa_output/bafin_request.txt");
    }

    printf("Success.\n");

    // Clear the REST object for any subsequent requests..
    CkRest_ClearAllHeaders(rest);
    CkRest_ClearAllParts(rest);
    CkRest_putPartSelector(rest,"");


    CkRest_Dispose(rest);
    CkXml_Dispose(soapXml);
    CkBinData_Dispose(bdRequest);

    }