convertAndCombine (rest)

« Back to api method list

API versions: 1.0 – 3.0

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

URL

https://services.drawloop.com/api/version/rest/convertAndCombine.format

API Version

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

Formats

string, xml, json

Parameters

Parameters with a * are required

• fillData

  Data formatted similar to a querystring (name1=value1&name2=value2) used to fill (merge) files. The name should match the <> tags or the range name for Microsoft Excel or the field name for Adobe PDF.

• outputOriginal

  When downloading the result file(s) of this call, the original file(s), after filling (merging), will be available for download.

• outputConverted

  When downloading the result file(s) of this call, the individual converted file(s) will be available for download.

• copyTables Available as of: 2.0

  Tables in Microsoft Word may be copied. This is done based on tags in the table. For each table you wish to copy, you must pass a tag in that table, the name of the file that table appears in, and the number of total copies you want all sepsrated by the ‘|’ character. If you wish to copy more than one table, this parameter can be passed in with multiple ‘|’ seperated groups which are seperated by the ‘&’ character. (e.g. tag1|file1.doc|5&tag2|file2.doc|3)

• copyRows Available as of: 2.0

  Rows in Microsoft Word and Microsoft Excel may be copied. This is done based on tags in the row or by having a range name across an entire row. For each row you wish to copy, you must pass a tag found in that row, or the range name of the row, the name of the file that row appears in, and the number of total copies you want all sepsrated by the ‘|’ character. If you wish to copy more than one row, this parameter can be passed in with multiple ‘|’ seperated groups which are seperated by the ‘&’ character. (e.g. tag1|file1.doc|5&rangeName1|file2.xls|3)

In addition, you must include certain numbered parameters which are used for determining the file(s) and/or URL(s) to convert as well as the final page order. Numbering for these parameters starts at one.

URL parameters (at least one of this set, or one File parameter is required)

• url_#_id *

  A unique identifier for this conversion that will be used later in the process to identify the converted url during the combine step.

• url_#_url *

  The url to convert.

• url_#_name *

  The name the converted url will be saved as.

File parameters (at least one of this set, or one URL parameter is required)

• file_#_id *

  A unique identifier for this conversion that will be used later in the process to identify the converted file during the combine step.

• file_#_file *

  A posted file using a standard HTTP post.

• file_#_name *

  The name the converted file will be saved as.

Combine parameters (at least one of this set is required)

The API supports combining into multiple result files. The first # sign in the following parameters refers to the resulting file, the second # refers to the section of that file. Numbering for these parameters starts at one.

• combine_#_name *

  The name of a specific combined file.

• combine_#_section_#_id *

  The file id from above (url_#_id or file_#_id) that is used in this section of the combined file.

• combine_#_section_#_bookmark

  The PDF bookmark for this section.

• combine_#_section_#_start

  The starting page from the file (url_#_id or file_#_id) for this section.

• combine_#_section_#_end

  The ending page from the file (url_#_id or file_#_id) for this section.

Example Responses

XML

<?xml version="1.0" standalone="yes"?>
<jobId>
    <![CDATA[jobId]]>
</jobId>

JSON

"jobId"