Xbase++

Send SOAP multipart/related with XML Body and Zip Attachment

See more REST Misc Examples

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

LOCAL nSuccess
LOCAL oRest
LOCAL oXml
LOCAL oBd
LOCAL nBAutoReconnect
LOCAL cResponseStr
LOCAL oBdRequest

nSuccess := 0

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

oRest := CreateObject("Chilkat.Rest")

oRest:AddHeader("Accept-Encoding", "gzip,deflate")
oRest:AddHeader("SOAPAction", "invio")
oRest:AddHeader("Content-Type", 'Multipart/Related; boundary="MIME_boundary"; type="text/xml"; start="mailto:rootpart@soapui.org"')
oRest: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

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

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

//  Build the sub-part containing the .zip
oRest:PartSelector := "2"
oRest:AddHeader("Content-Type", "application/zip")
oRest:AddHeader("Content-Transfer-Encoding", "binary")
oRest:AddHeader("Content-ID", "<myfile.zip>")
oRest: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.
oBd := CreateObject("Chilkat.BinData")
nSuccess := oBd:LoadFile("qa_data/zips/helloWorld.zip")
nSuccess := oRest:SetMultipartBodyBd(oBd)

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

//  Send the request by connecting to the web server and then sending..
//  Connect using TLS.
nBAutoReconnect := 1
nSuccess := oRest:Connect("www.chilkatsoft.com", 443, 1, nBAutoReconnect)
IF (nSuccess != 1)
    ? oRest:LastErrorText
    oRest:destroy()
    oXml:destroy()
    oBd:destroy()
    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..
oRest:DebugMode := 1

cResponseStr := oRest:FullRequestMultipart("POST", "/someTargetPath")
IF (oRest:LastMethodSuccess != 1)
    ? oRest:LastErrorText
    oRest:destroy()
    oXml:destroy()
    oBd:destroy()
    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..)
oBdRequest := CreateObject("Chilkat.BinData")
oRest:GetLastDebugRequest(oBdRequest)
nSuccess := oBdRequest:WriteFile("qa_output/multipartRelatedRequest.bin")

? "OK, examine the output file.."

oRest:destroy()
oXml:destroy()
oBd:destroy()
oBdRequest:destroy()