PowerBuilder

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. PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Rest
oleobject loo_Xml
oleobject loo_Bd
integer li_BAutoReconnect
string ls_ResponseStr
oleobject loo_BdRequest

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

loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")
if li_rc < 0 then
    destroy loo_Rest
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

loo_Xml = create oleobject
li_rc = loo_Xml.ConnectToNewObject("Chilkat.Xml")

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

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

// Build the sub-part containing the .zip
loo_Rest.PartSelector = "2"
loo_Rest.AddHeader("Content-Type","application/zip")
loo_Rest.AddHeader("Content-Transfer-Encoding","binary")
loo_Rest.AddHeader("Content-ID","<myfile.zip>")
loo_Rest.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.
loo_Bd = create oleobject
li_rc = loo_Bd.ConnectToNewObject("Chilkat.BinData")

li_Success = loo_Bd.LoadFile("qa_data/zips/helloWorld.zip")
li_Success = loo_Rest.SetMultipartBodyBd(loo_Bd)

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

// Send the request by connecting to the web server and then sending..
// Connect using TLS.
li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("www.chilkatsoft.com",443,1,li_BAutoReconnect)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    destroy loo_Xml
    destroy loo_Bd
    return
end if

// 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..
loo_Rest.DebugMode = 1

ls_ResponseStr = loo_Rest.FullRequestMultipart("POST","/someTargetPath")
if loo_Rest.LastMethodSuccess <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    destroy loo_Xml
    destroy loo_Bd
    return
end if

// 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..)
loo_BdRequest = create oleobject
li_rc = loo_BdRequest.ConnectToNewObject("Chilkat.BinData")

loo_Rest.GetLastDebugRequest(loo_BdRequest)
li_Success = loo_BdRequest.WriteFile("qa_output/multipartRelatedRequest.bin")

Write-Debug "OK, examine the output file.."


destroy loo_Rest
destroy loo_Xml
destroy loo_Bd
destroy loo_BdRequest