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

LOCAL loRest
LOCAL lnSuccess
LOCAL loXml
LOCAL loBd
LOCAL lnBAutoReconnect
LOCAL lcResponseStr
LOCAL loBdRequest

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

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

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Xml')
loXml = CreateObject('Chilkat.Xml')
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>")
lnSuccess = 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.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.BinData')
loBd = CreateObject('Chilkat.BinData')
lnSuccess = loBd.LoadFile("qa_data/zips/helloWorld.zip")
lnSuccess = 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.
lnBAutoReconnect = 1
lnSuccess = loRest.Connect("www.chilkatsoft.com",443,1,lnBAutoReconnect)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    RELEASE loXml
    RELEASE loBd
    CANCEL
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 = 1

lcResponseStr = loRest.FullRequestMultipart("POST","/someTargetPath")
IF (loRest.LastMethodSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    RELEASE loXml
    RELEASE loBd
    CANCEL
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..)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.BinData')
loBdRequest = CreateObject('Chilkat.BinData')
loRest.GetLastDebugRequest(loBdRequest)
lnSuccess = loBdRequest.WriteFile("qa_output/multipartRelatedRequest.bin")

? "OK, examine the output file.."

RELEASE loRest
RELEASE loXml
RELEASE loBd
RELEASE loBdRequest