convert (soap)

« Back to api method list

API versions: 1.0 – 3.0

download the wsdl

Merge data and convert the file or URL to PDF

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.

• convertTarget *

  A complex type defining what you want to convert. Use either the ConvertUrl type or the Document type.

• 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).

• outputOriginal

  A boolean value used to determine if the original file should be included in the results. If fillData is used, this will be the filled file (merged file).

• 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/version/soap HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.drawloop.com/convert"

<?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>
        <convert xmlns="http://services.drawloop.com/">
            <userId>userId</userId>
    <password>password</password>
            <key>key</key>
            <convertTarget>ConvertUrl or Document</convertTarget>
            <callbackUri>CallbackUri</callbackUri>
            <fillData>array of Data</fillData>
            <outputOriginal>boolean</outputOriginal>
        </convert>
    </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>
        <convertResponse xmlns="http://services.drawloop.com/">
            <convertResult>jobId</convertResult>
        </convertResponse>
    </soap:Body>
</soap:Envelope>