(Lianja) Send SOAP multipart/related with XML Body and Zip Attachment

Demonstrates how to construct and send a multipart/related POST containing a SOAP XML body and a binary zip attachment.

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

// This example constructs and sends the following HTTP request.
// (The boundary strings will be different and auto-generated by Chilkat)

// Accept-Encoding: gzip,deflate
// SOAPAction: invio
// Content-Type: Multipart/Related; boundary="MIME_boundary"; type="text/xml"; start="mailto:rootpart@soapui.org"
// MIME-Version: 1.0
// 
// --MIME_boundary
// Content-Type: text/xml; charset=UTF-8
// Content-Transfer-Encoding: 8bit
// Content-ID: <rootpart@soapui.org>
//  
// <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:attachment.ws.it">
// <soapenv:Header/>
// <soapenv:Body>
//   <urn:inputBean>
//    <nomeFileAllegato>myfile.zip</nomeFileAllegato>
//   </urn:inputBean>
// </soapenv:Body>
// </soapenv:Envelope>
//  
// --MIME_boundary
// Content-Type: application/zip
// Content-Transfer-Encoding: binary
// Content-ID: <myfile.zip>
// Content-Disposition: attachment; name="myfile.zip"; filename="myfile.zip"
// 
// ... binary zip data goes here ...
// --MIME_boundary--
// 

loRest = createobject("CkRest")

loRest.AddHeader("Accept-Encoding","gzip,deflate")
loRest.AddHeader("SOAPAction","invio")
loRest.AddHeader("Content-Type",'Multipart/Related; boundary="MIME_boundary"; type="text/xml"; start="mailto:rootpart@soapui.org"')
loRest.AddHeader("MIME-Version","1.0")

// Build the SOAP XML:
// Use this online tool to generate the code from sample XML: 
// Generate Code to Create XML

loXml = createobject("CkXml")
loXml.Tag = "soapenv:Envelope"
loXml.AddAttribute("xmlns:soapenv","http://schemas.xmlsoap.org/soap/envelope/")
loXml.AddAttribute("xmlns:urn","urn:attachment.ws.it")
loXml.UpdateChildContent("soapenv:Header","")
loXml.UpdateChildContent("soapenv:Body|urn:inputBean|nomeFileAllegato","myfile.zip")

// Build the SOAP XML sub-part
loRest.PartSelector = "1"
loRest.AddHeader("Content-Type","text/xml; charset=UTF-8")
loRest.AddHeader("Content-Transfer-Encoding","8bit")
loRest.AddHeader("Content-ID","<rootpart@soapui.org>")
llSuccess = loRest.SetMultipartBodyString(loXml.GetXml())

// Build the sub-part containing the .zip
loRest.PartSelector = "2"
loRest.AddHeader("Content-Type","application/zip")
loRest.AddHeader("Content-Transfer-Encoding","binary")
loRest.AddHeader("Content-ID","<myfile.zip>")
loRest.AddHeader("Content-Disposition",'attachment; name="myfile.zip"; filename="myfile.zip"')

// Add a zip file to the 2nd sub-part body.
// This example will load the .zip file into memory, but it is also possible to stream directly from the file as the request is sent
// by calling SetMultipartBodyStream.
loBd = createobject("CkBinData")
llSuccess = loBd.LoadFile("qa_data/zips/helloWorld.zip")
llSuccess = loRest.SetMultipartBodyBd(loBd)

// To be safe, always revert the PartSelector back to 0..
loRest.PartSelector = "0"

// Send the request by connecting to the web server and then sending..
// Connect using TLS.
llBAutoReconnect = .T.
llSuccess = loRest.Connect("www.chilkatsoft.com",443,.T.,llBAutoReconnect)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loRest
    release loXml
    release loBd
    return
endif

// In this example, we're setting DebugMode.
// When debug mode is turned on, no request is actually sent.
// Instead, the request that would be sent is recorded to memory
// and we can retrieve it afterwards..
loRest.DebugMode = .T.

lcResponseStr = loRest.FullRequestMultipart("POST","/someTargetPath")
if (loRest.LastMethodSuccess <> .T.) then
    ? loRest.LastErrorText
    release loRest
    release loXml
    release loBd
    return
endif

// Retrieve the request that would've been sent and save it to a file.
// We can then examine the file to see if the request was structured as we desired.
// (Note: The zip bytes will be binary data and will appear as garbled garbage in a text editor..)
loBdRequest = createobject("CkBinData")
loRest.GetLastDebugRequest(loBdRequest)
llSuccess = loBdRequest.WriteFile("qa_output/multipartRelatedRequest.bin")

? "OK, examine the output file.."


release loRest
release loXml
release loBd
release loBdRequest