C

How to Access Parts of a multipart/related HTTP Response

See more HTTP Examples

Demonstrates how to access the parts of a multipart/related response. This example sends a ficticious multipart/related request, and handles a ficticious multipart/related response.

We send the following multipart/related request:

Content-Type: multipart/related; start-info="text/xml"; type="application/xop+xml"; boundary="----=_Part_0_1744155.1118953559416"
Content-Length: 3453
SOAPAction: "some-SOAP-action"

------=_Part_1_4558657.1118953559446
Content-Type: application/xop+xml; type="text/xml"; charset=utf-8

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Detail xmlns="http://example.org/mtom/data">
      <image>
        <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:5aeaa450-17f0-4484-b845-a8480c363444@example.org" />
      </image>
    </Detail>
  </soap:Body>
</soap:Envelope>

------=_Part_1_4558657.1118953559446
Content-Type: image/jpeg
Content-ID: <5aeaa450-17f0-4484-b845-a8480c363444@example.org>


... binary data ...

C

#include <C_CkHttp.h>
#include <C_CkXml.h>
#include <C_CkHttpRequest.h>
#include <C_CkHttpResponse.h>
#include <C_CkMime.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkHttp http;
    HCkXml soapXml;
    const char *xmlBody;
    HCkHttpRequest req;
    BOOL useTls;
    HCkHttpResponse resp;
    HCkMime mime;
    HCkMime part0;
    const char *subPartXmlBody;

    success = FALSE;

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

    http = CkHttp_Create();

    soapXml = CkXml_Create();

    // Build the following SOAP XML

    // <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    //   <soap:Body>
    //     <Detail xmlns="http://example.org/mtom/data">
    //       <image>
    //         <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:5aeaa450-17f0-4484-b845-a8480c363444@example.org" />
    //       </image>
    //     </Detail>
    //   </soap:Body>
    // </soap:Envelope>

    CkXml_putTag(soapXml,"soap:Envelope");
    CkXml_AddAttribute(soapXml,"xmlns:soap","http://schemas.xmlsoap.org/soap/envelope/");
    CkXml_UpdateAttrAt(soapXml,"soap:Body|Detail",TRUE,"xmlns","http://example.org/mtom/data");
    CkXml_UpdateAttrAt(soapXml,"soap:Body|Detail|image|xop:Include",TRUE,"xmlns:xop","http://www.w3.org/2004/08/xop/include");
    CkXml_UpdateAttrAt(soapXml,"soap:Body|Detail|image|xop:Include",TRUE,"href","cid:5aeaa450-17f0-4484-b845-a8480c363444@example.org");

    CkXml_putEmitXmlDecl(soapXml,FALSE);
    xmlBody = CkXml_getXml(soapXml);
    printf("%s\n",xmlBody);

    req = CkHttpRequest_Create();
    CkHttpRequest_putHttpVerb(req,"POST");
    CkHttpRequest_putPath(req,"/something/someTarget");

    CkHttpRequest_putContentType(req,"multipart/related; start-info=\"text/xml\"; type=\"application/xop+xml\"");
    CkHttpRequest_AddHeader(req,"SOAPAction","some-SOAP-action");

    success = CkHttpRequest_AddStringForUpload2(req,"","",xmlBody,"utf-8","application/xop+xml; type=\"text/xml\"; charset=utf-8");

    // The bytes will be sent as binary (not base64 encoded).
    success = CkHttpRequest_AddFileForUpload2(req,"","qa_data/jpg/starfish.jpg","image/jpeg");

    // The JPEG data is the 2nd sub-part, and therefore is at index 1 (the first sub-part is at index 0)
    success = CkHttpRequest_AddSubHeader(req,1,"Content-ID","<5aeaa450-17f0-4484-b845-a8480c363444@example.org>");

    CkHttp_putFollowRedirects(http,TRUE);

    useTls = TRUE;
    resp = CkHttpResponse_Create();
    success = CkHttp_HttpSReq(http,"www.example.org",443,useTls,req,resp);
    if (success == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkXml_Dispose(soapXml);
        CkHttpRequest_Dispose(req);
        CkHttpResponse_Dispose(resp);
        return;
    }

    // Imagine the HTTP response is multipart related and is something like this:

    // HTTP/1.1 200 OK
    // Cache-Control: no-cache, no-store
    // Pragma: no-cache
    // Transfer-Encoding: chunked
    // Content-Type: multipart/related; boundary=------------080001080500020607080905
    // Expires: -1
    // Server: Microsoft-IIS/10.0
    // X-AspNet-Version: 4.0.30319
    // X-Powered-By: ASP.NET
    // Date: Wed, 19 Feb 2020 15:27:06 GMT
    // 
    // --------------080001080500020607080905
    // Content-Type: application/xop+xml; charset=iso-8859-1
    // Content-Id: RootPart
    // Content-Transfer-Encoding: binary
    // 
    // <?xml version="1.0" encoding="iso-8859-1"?>
    // <soapenv:Envelope xmlns:xcpt="...">
    //   <soapenv:Header />
    //   <soapenv:Body>
    //     <xres:Transport profile="http://something.example.com/..." version="1.4">
    //       <xres:TransportHeader>
    // 	...
    // 	...
    //       </xres:TransportHeader>
    //       <xres:TransportBody />
    //     </xres:Transport>
    //   </soapenv:Body>
    // </soapenv:Envelope>
    // --------------080001080500020607080905--

    // To get the XML, load the full MIME of the response into a Chilkat MIME object.  Then get the body of the 1st sub-part.
    mime = CkMime_Create();
    CkMime_LoadMime(mime,CkHttpResponse_fullMime(resp));

    // Your code might verify that the Content-Type is indeed multipart/related.
    printf("%s\n",CkMime_contentType(mime));
    printf("num parts = %d\n",CkMime_getNumParts(mime));

    // Assuming it is, and the number of sub-parts is > 0
    if (CkMime_getNumParts(mime) > 0) {

        part0 = CkMime_Create();
        CkMime_PartAt(mime,0,part0);

        // The Content-Type (in this ficticious example) should be "application/xop+xml"
        printf("sub-part Content-Type: %s\n",CkMime_contentType(part0));
        // Now get the XML 
        subPartXmlBody = CkMime_getBodyDecoded(part0);
        printf("%s\n",subPartXmlBody);
    }



    CkHttp_Dispose(http);
    CkXml_Dispose(soapXml);
    CkHttpRequest_Dispose(req);
    CkHttpResponse_Dispose(resp);
    CkMime_Dispose(mime);
    CkMime_Dispose(part0);

    }