Data Structures

Description

The specifics of your file conversion, including a description of all of the input files and the desired output file.  This can be represented as either XML or JSON, and examples of both are provided below.

Example (XML)

<conversion>
  <outputFormat>application/pdf</outputFormat>
  <outputDimensions>
    <widthInPoints>612</widthInPoints>
    <heightInPoints>792</heightInPoints>
  </outputDimensions>
  <conversionFiles>
    <conversionFile>
      <uri>fileId:53235</uri>
      <index>0</index>
      <mimeType>application/pdf</mimeType>
    </conversionFile>
    <conversionFile>
      <uri>fileId:53783</uri>
      <index>1</index>
      <mimeType>application/msword</mimeType>
    </conversionFile>
  </conversionFiles>
  <customField>JobIdentifier12345</customField>
  <callback>
    <url>http://www.mydomain.com/publish/convert/notification_url.php</url>
    <mimeType>application/xml</mimeType>
  </callback>
</conversion>
    

Example (JSON)

{
  "outputFormat": "application/pdf",
  "outputDimensions": {
    "widthInPoints": 612,
    "heightInPoints": 792
  },
  "conversionFiles": [{
      "uri": "fileId:53235",
      "index": 0,
      "mimeType": "application/pdf"
    }, {
      "uri": "fileId:53783",
      "index": 1,
      "mimeType": "application/msword"
    }
  ],
  "customField": "JobIdentifier12345",
  "callback": {
    "url": "http://www.mydomain.com/publish/convert/notification_url.php",
    "mimeType": "application/json"
  }
}
    

Fields

Output Dimensions

Description

The output dimensions are specified in points. For example, an 8.5"x11" page size would be specified using the dimensions 612x792. Any input file pages that are not the specified size will be resized during the conversion process. For optimal results, it is recommended that properly sized files be provided to avoid resizing..

Fields

Source Files

Description

A representation of a single file to be converted and concatenated into the resulting file.  The location of each file is specified using a custom URI that identifies a file that has been previously uploaded into your files. See the upload call for more information about uploading files and obtaining the corresponding file identifier.

Fields

Description

Document conversion is an asynchronous process.  When a conversion is begun the job is queued and a status is returned immediately.  This structure includes information about each document in the conversion request as well as an overall status of the job.

Example (XML)

In this example, a job is currently undergoing conversion. Given two input files, one of them has been completed (with a notification that it was resized to the output dimensions), while the other is awaiting conversion.

<conversion>
  <conversionId>12345</conversionId>
  <status>CONVERTING</status>
  <outputFileId/>
  <conversionStartDate>2011-01-31T14:16:37.782-05:00</conversionStartDate>
  <outputFormat>application/pdf</outputFormat>
  <outputDimensions>
    <heightInPoints>750.0</heightInPoints>
    <widthInPoints>750.0</widthInPoints>
  </outputDimensions>
  <customField>JobIdentifier12345</customField>
  <callback>
    <url>http://www.mydomain.com/publish/convert/notification_url.php</url>
    <mimeType>application/xml</mimeType>
  </callback>
  <conversionFiles>
    <conversionFile>
      <conversionFileId>34567</conversionFileId>
      <uri>fileId:53235</uri>
      <index>0</index>
      <status>COMPLETED</status>
      <notifications>
        <notification>
          <text>File was resized to the requested output dimensions</text>
          <severity>WARNING</severity>
          <code>1100000004</code>
        </notification>
      </notifications>
      <mimeType>application/pdf</mimeType>
      <downloadStartDate>2011-01-31T14:16:37.822-05:00</downloadStartDate>
      <downloadEndDate>2011-01-31T14:16:37.851-05:00</downloadEndDate>
      <conversionStartDate>2011-01-31T14:16:37.871-05:00</conversionStartDate>
      <conversionEndDate>2011-01-31T14:16:37.897-05:00</conversionEndDate>
    </conversionFile>
    <conversionFile>
      <conversionFileId>34568</conversionFileId>
      <uri>fileId:53783</uri>
      <index>1</index>
      <status>QUEUED_FOR_CONVERSION</status>
      <mimeType>application/pdf</mimeType>
      <downloadStartDate>2011-01-31T14:16:37.830-05:00</downloadStartDate>
      <downloadEndDate>2011-01-31T14:16:37.832-05:00</downloadEndDate>
    </conversionFile>
  </conversionFiles>
</conversion>
    

Example (JSON)

{
   "conversion":{
      "conversionId":12345,
      "status":"CONVERTING",
      "outputFileId":null,
      "notifications":[],
      "conversionStartDate":"2011-01-31T14:16:37-05:00",
      "manifestId":23456,
      "outputFormat":"application/pdf",
      "outputDimensions":{
         "widthInPoints":750.0,
         "heightInPoints":750.0
      },
      "customField":"jobIdentifier12345",
      "conversionFiles":[
         {
            "conversionFileId":34567,
            "uri":"fileId:53235",
            "index":0,
            "status":"COMPLETED",
            "notifications": [{
               "text": "File was resized to the requested output dimensions",
               "details": null,
               "severity": "WARNING",
               "code":1100000004}],
            }],
            "mimeType":"application/pdf",
            "downloadStartDate":"2011-01-31T14:16:37-05:00",
            "downloadEndDate":"2011-01-31T14:16:37-05:00",
            "conversionStartDate":"2011-01-31T14:16:37-05:00",
            "conversionEndDate":"2011-01-31T14:16:37-05:00"
         },
         {
            "conversionFileId":34568,
            "uri":"fileId:53783",
            "index":1,
            "status":"QUEUED_FOR_CONVERSION",
            "mimeType":"application/pdf",
            "downloadStartDate":"2011-01-31T14:16:37-05:00",
            "downloadEndDate":"2011-01-31T14:16:37-05:00"
         }
      ]
   }
    }

Fields

The response consists of the elements from the conversion manifest with a few additional fields added.  The fields may not be included in the response if they are not relevant. For example, if the conversion has not yet completed, the "conversionEndDate" and "outputFileId" fields may not appear.