Delphi DLL

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. Delphi DLL

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, BinData, Rest, Xml;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
rest: HCkRest;
xml: HCkXml;
bd: HCkBinData;
bAutoReconnect: Boolean;
responseStr: PWideChar;
bdRequest: HCkBinData;

begin
success := False;

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

rest := CkRest_Create();

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

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

xml := CkXml_Create();
CkXml_putTag(xml,'soapenv:Envelope');
CkXml_AddAttribute(xml,'xmlns:soapenv','http://schemas.xmlsoap.org/soap/envelope/');
CkXml_AddAttribute(xml,'xmlns:urn','urn:attachment.ws.it');
CkXml_UpdateChildContent(xml,'soapenv:Header','');
CkXml_UpdateChildContent(xml,'soapenv:Body|urn:inputBean|nomeFileAllegato','myfile.zip');

// Build the SOAP XML sub-part
CkRest_putPartSelector(rest,'1');
CkRest_AddHeader(rest,'Content-Type','text/xml; charset=UTF-8');
CkRest_AddHeader(rest,'Content-Transfer-Encoding','8bit');
CkRest_AddHeader(rest,'Content-ID','<rootpart@soapui.org>');
success := CkRest_SetMultipartBodyString(rest,CkXml__getXml(xml));

// Build the sub-part containing the .zip
CkRest_putPartSelector(rest,'2');
CkRest_AddHeader(rest,'Content-Type','application/zip');
CkRest_AddHeader(rest,'Content-Transfer-Encoding','binary');
CkRest_AddHeader(rest,'Content-ID','<myfile.zip>');
CkRest_AddHeader(rest,'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.
bd := CkBinData_Create();
success := CkBinData_LoadFile(bd,'qa_data/zips/helloWorld.zip');
success := CkRest_SetMultipartBodyBd(rest,bd);

// To be safe, always revert the PartSelector back to 0..
CkRest_putPartSelector(rest,'0');

// Send the request by connecting to the web server and then sending..
// Connect using TLS.
bAutoReconnect := True;
success := CkRest_Connect(rest,'www.chilkatsoft.com',443,True,bAutoReconnect);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

// 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..
CkRest_putDebugMode(rest,True);

responseStr := CkRest__fullRequestMultipart(rest,'POST','/someTargetPath');
if (CkRest_getLastMethodSuccess(rest) <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

// 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..)
bdRequest := CkBinData_Create();
CkRest_GetLastDebugRequest(rest,bdRequest);
success := CkBinData_WriteFile(bdRequest,'qa_output/multipartRelatedRequest.bin');

Memo1.Lines.Add('OK, examine the output file..');

CkRest_Dispose(rest);
CkXml_Dispose(xml);
CkBinData_Dispose(bd);
CkBinData_Dispose(bdRequest);

end;