convertAndCombine (soap)

« Back to api method list

API versions: 1.0 – 3.0

download the wsdl

Merge data and convert the files and/or URLs to PDF; then combine them into one or more PDF files

API Version

We recommend always using the latest version of the API. Please see the available versions here.

Parameters

Parameters with a * are required

• userId *

  The user for this API call.

• password *

  The password for the user.

• key *

  The API key for this account. To request an API key, please go to our API key request page.

• documents (either this or urls is required)

  An array of Document objects used to pass in file(s) to convert to PDF and use in the combined file(s).

• urls (either this or documents is required)

  An array of ConvertUrl objects used to determine which url(s) to convert to PDF and use in the combined file(s).

• results *

  An array of ConvertAndCombineFile objects used to determine the combined file(s) for this job.

• callbackUri

  A complex type CallbackUri used to send the jobId and files to a specific uri when the job is complete.

• fillData

  An array of Data objects used to fill the file with data (merge data).

• outputOptions

  A complex type OutputOptions used to determine if the original file(s) and the intermediary file(s) should be included in the results.

• copyTables Available as of 2.0

  An array of CopyTable objects used to determine what tables to copy.

• copyRows Available as of 2.0

  An array of CopyRow objects used to determine what rows to copy.

SOAP Request

POST /api/1.0/soap HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://services.drawloop.com/convertAndCombine"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <convertAndCombine xmlns="http://services.drawloop.com/">
            <userId>userId</userId>
            <password>password</password>
            <key>key</key>
            <documents>array of Document</documents>
            <urls>array of ConvertUrl</urls>
            <results>array of ConvertAndCombineFile</results>
            <callbackUri>CallbackUri</callbackUri>
            <fillData>array of Data</fillData>
            <outputOptions>OutputOptions</outputOptions>
        </convertAndCombine>
    </soap:Body>
</soap:Envelope>

SOAP Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <convertAndCombineResponse xmlns="http://services.drawloop.com/">
            <convertAndCombineResult>jobId</convertAndCombineResult>
        </convertAndCombineResponse>
    </soap:Body>
</soap:Envelope>