Webservice: Conversion

document conversion [Commercial editions only]

Index Method Request(s) Response Description
1 convertDocument sid
docId
fileVersion
format
 conversion converts an existing document and downloads the generated conversion
2 convertFile sid
fileName
format
fileContent
 conversion converts a given file and downloads the generated conversion
3 convertDocumentAndSave sid
docId
fileVersion
format
 docId converts an existing document and stores the generated conversion in LogicalDOC
4 convertDocumentToPdf sid
docId
fileVersion
 converts the document to PDF and saves the conversion as document's resource(suffix 'conversion.pdf' ); if the conversion was already created, nothing happens

Method #1: convertDocument

converts an existing document and downloads the generated conversion

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y
     fileVersion
String Y
     format
String Y output format, eg: pdf, csv, xls ...

Response

Name Type Required Multiple Description
     conversion
DataHandler Y

Method #2: convertFile

converts a given file and downloads the generated conversion

Request

Name Type Required Multiple Description
     sid
String Y
     fileName
String Y name of the source file
     format
String Y output format, eg: pdf, csv, xls ...
     fileContent
DataHandler Y the raw content of the file

Response

Name Type Required Multiple Description
     conversion
DataHandler Y

Method #3: convertDocumentAndSave

converts an existing document and stores the generated conversion in LogicalDOC

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y
     fileVersion
String Y
     format
String Y output format, eg: pdf, csv, xls ...

Response

Name Type Required Multiple Description
     docId
Long Y

Method #4: convertDocumentToPdf

converts the document to PDF and saves the conversion as document's resource(suffix 'conversion.pdf' ); if the conversion was already created, nothing happens

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y
     fileVersion
String the specific file version