(Visual FoxPro) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loHttp
LOCAL loSoapXml
LOCAL lcXmlBody
LOCAL loReq
LOCAL lnUseTls
LOCAL loResp
LOCAL loMime
LOCAL loPart0
LOCAL lcSubPartXmlBody

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Xml')
loSoapXml = CreateObject('Chilkat.Xml')

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

loSoapXml.Tag = "soap:Envelope"
loSoapXml.AddAttribute("xmlns:soap","http://schemas.xmlsoap.org/soap/envelope/")
loSoapXml.UpdateAttrAt("soap:Body|Detail",1,"xmlns","http://example.org/mtom/data")
loSoapXml.UpdateAttrAt("soap:Body|Detail|image|xop:Include",1,"xmlns:xop","http://www.w3.org/2004/08/xop/include")
loSoapXml.UpdateAttrAt("soap:Body|Detail|image|xop:Include",1,"href","cid:5aeaa450-17f0-4484-b845-a8480c363444@example.org")

loSoapXml.EmitXmlDecl = 0
lcXmlBody = loSoapXml.GetXml()
? lcXmlBody

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.HttpRequest')
loReq = CreateObject('Chilkat.HttpRequest')
loReq.HttpVerb = "POST"
loReq.Path = "/something/someTarget"

loReq.ContentType = 'multipart/related; start-info="text/xml"; type="application/xop+xml"'
loReq.AddHeader("SOAPAction","some-SOAP-action")

lnSuccess = loReq.AddStringForUpload2("","",lcXmlBody,"utf-8",'application/xop+xml; type="text/xml"; charset=utf-8')

* The bytes will be sent as binary (not base64 encoded).
lnSuccess = loReq.AddFileForUpload2("","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)
lnSuccess = loReq.AddSubHeader(1,"Content-ID","<5aeaa450-17f0-4484-b845-a8480c363444@example.org>")

loHttp.FollowRedirects = 1

lnUseTls = 1
loResp = loHttp.SynchronousRequest("www.example.org",443,lnUseTls,loReq)
IF (loHttp.LastMethodSuccess <> 1) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSoapXml
    RELEASE loReq
    CANCEL
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.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Mime')
loMime = CreateObject('Chilkat.Mime')
loMime.LoadMime(loResp.FullMime)

* Your code might verify that the Content-Type is indeed multipart/related.
? loMime.ContentType
? "num parts = " + STR(loMime.NumParts)

* Assuming it is, and the number of sub-parts is > 0
IF (loMime.NumParts > 0) THEN
    loPart0 = loMime.GetPart(0)
    * The Content-Type (in this ficticious example) should be "application/xop+xml"
    ? "sub-part Content-Type: " + loPart0.ContentType
    * Now get the XML 
    lcSubPartXmlBody = loPart0.GetBodyDecoded()
    ? lcSubPartXmlBody
    RELEASE loPart0
ENDIF

RELEASE loResp

RELEASE loHttp
RELEASE loSoapXml
RELEASE loReq
RELEASE loMime