(PureBasic) How to Access Parts of a multipart/related HTTP Response

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

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkMime.pb"
IncludeFile "CkXml.pb"
IncludeFile "CkHttpRequest.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    soapXml.i = CkXml::ckCreate()
    If soapXml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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::setCkTag(soapXml, "soap:Envelope")
    CkXml::ckAddAttribute(soapXml,"xmlns:soap","http://schemas.xmlsoap.org/soap/envelope/")
    CkXml::ckUpdateAttrAt(soapXml,"soap:Body|Detail",1,"xmlns","http://example.org/mtom/data")
    CkXml::ckUpdateAttrAt(soapXml,"soap:Body|Detail|image|xop:Include",1,"xmlns:xop","http://www.w3.org/2004/08/xop/include")
    CkXml::ckUpdateAttrAt(soapXml,"soap:Body|Detail|image|xop:Include",1,"href","cid:5aeaa450-17f0-4484-b845-a8480c363444@example.org")

    CkXml::setCkEmitXmlDecl(soapXml, 0)
    xmlBody.s = CkXml::ckGetXml(soapXml)
    Debug xmlBody

    req.i = CkHttpRequest::ckCreate()
    If req.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpRequest::setCkHttpVerb(req, "POST")
    CkHttpRequest::setCkPath(req, "/something/someTarget")

    CkHttpRequest::setCkContentType(req, "multipart/related; start-info=" + Chr(34) + "text/xml" + Chr(34) + "; type=" + Chr(34) + "application/xop+xml" + Chr(34))
    CkHttpRequest::ckAddHeader(req,"SOAPAction","some-SOAP-action")

    success = CkHttpRequest::ckAddStringForUpload2(req,"","",xmlBody,"utf-8","application/xop+xml; type=" + Chr(34) + "text/xml" + Chr(34) + "; charset=utf-8")

    ; The bytes will be sent as binary (not base64 encoded).
    success = CkHttpRequest::ckAddFileForUpload2(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::ckAddSubHeader(req,1,"Content-ID","<5aeaa450-17f0-4484-b845-a8480c363444@example.org>")

    CkHttp::setCkFollowRedirects(http, 1)

    useTls.i = 1
    resp.i = CkHttp::ckSynchronousRequest(http,"www.example.org",443,useTls,req)
    If CkHttp::ckLastMethodSuccess(http) <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkXml::ckDispose(soapXml)
        CkHttpRequest::ckDispose(req)
        ProcedureReturn
    EndIf

    ; 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.i = CkMime::ckCreate()
    If mime.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkMime::ckLoadMime(mime,CkHttpResponse::ckFullMime(resp))

    ; Your code might verify that the Content-Type is indeed multipart/related.
    Debug CkMime::ckContentType(mime)
    Debug "num parts = " + Str(CkMime::ckNumParts(mime))

    ; Assuming it is, and the number of sub-parts is > 0
    If CkMime::ckNumParts(mime) > 0
        part0.i = CkMime::ckGetPart(mime,0)
        ; The Content-Type (in this ficticious example) should be "application/xop+xml"
        Debug "sub-part Content-Type: " + CkMime::ckContentType(part0)
        ; Now get the XML 
        subPartXmlBody.s = CkMime::ckGetBodyDecoded(part0)
        Debug subPartXmlBody
        CkMime::ckDispose(part0)

    EndIf

    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkXml::ckDispose(soapXml)
    CkHttpRequest::ckDispose(req)
    CkMime::ckDispose(mime)


    ProcedureReturn
EndProcedure