(Tcl) 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 Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_CkHttp]

set soapXml [new_CkXml]

# 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_put_Tag $soapXml "soap:Envelope"
CkXml_AddAttribute $soapXml "xmlns:soap" "http://schemas.xmlsoap.org/soap/envelope/"
CkXml_UpdateAttrAt $soapXml "soap:Body|Detail" 1 "xmlns" "http://example.org/mtom/data"
CkXml_UpdateAttrAt $soapXml "soap:Body|Detail|image|xop:Include" 1 "xmlns:xop" "http://www.w3.org/2004/08/xop/include"
CkXml_UpdateAttrAt $soapXml "soap:Body|Detail|image|xop:Include" 1 "href" "cid:5aeaa450-17f0-4484-b845-a8480c363444@example.org"

CkXml_put_EmitXmlDecl $soapXml 0
set xmlBody [CkXml_getXml $soapXml]
puts "$xmlBody"

set req [new_CkHttpRequest]

CkHttpRequest_put_HttpVerb $req "POST"
CkHttpRequest_put_Path $req "/something/someTarget"

CkHttpRequest_put_ContentType $req "multipart/related; start-info=\"text/xml\"; type=\"application/xop+xml\""
CkHttpRequest_AddHeader $req "SOAPAction" "some-SOAP-action"

set 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).
set 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)
set success [CkHttpRequest_AddSubHeader $req 1 "Content-ID" "<5aeaa450-17f0-4484-b845-a8480c363444@example.org>"]

CkHttp_put_FollowRedirects $http 1

set useTls 1
# resp is a CkHttpResponse
set resp [CkHttp_SynchronousRequest $http "www.example.org" 443 $useTls $req]
if {[CkHttp_get_LastMethodSuccess $http] != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkXml $soapXml
    delete_CkHttpRequest $req
    exit
}

# 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.
set mime [new_CkMime]

CkMime_LoadMime $mime [CkHttpResponse_fullMime $resp]

# Your code might verify that the Content-Type is indeed multipart/related.
puts [CkMime_contentType $mime]
puts "num parts = [CkMime_get_NumParts $mime]"

# Assuming it is, and the number of sub-parts is > 0
if {[CkMime_get_NumParts $mime] > 0} then {
    # part0 is a CkMime
    set part0 [CkMime_GetPart $mime 0]
    # The Content-Type (in this ficticious example) should be "application/xop+xml"
    puts "sub-part Content-Type: [CkMime_contentType $part0]"
    # Now get the XML 
    set subPartXmlBody [CkMime_getBodyDecoded $part0]
    puts "$subPartXmlBody"
    delete_CkMime $part0

}

delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkXml $soapXml
delete_CkHttpRequest $req
delete_CkMime $mime