DS Server

DocumentProcessing

Endpoint

The DocumentProcessing endpoints under /documentprocessing convert, merge, append and inspect documents, create PDF documents, read the attachments, metadata and form fields of PDF documents and create barcodes. Documents are sent and returned as Base64 encoded strings in JSON. The .NET package TXTextControl.DocumentServices.DocumentProcessing calls the same endpoints (see the DocumentProcessing namespace).

MethodEndpointDescription
POST/documentprocessing/document/convertConverts a document to another supported format.
POST/documentprocessing/document/mergeMerges and returns a compatible uploaded template with hierarchical JSON data.
POST/documentprocessing/document/findandreplaceExecutes a find and replace on a template to create a document.
POST/documentprocessing/document/appendCombines documents by appending them divided by a new section, paragraph or nothing.
POST/documentprocessing/document/thumbnailsCreates and returns thumbnail images of documents.
POST/documentprocessing/document/infoReturns information about the document and document content.
GET/documentprocessing/document/installedprintersReturns information about the printers installed on the server.
POST/documentprocessing/pdf/createCreates a PDF document from an input document.
POST/documentprocessing/pdf/embeddedfilesReturns all embedded files from a given PDF document.
POST/documentprocessing/pdf/metadataExtracts metadata from a given PDF document.
POST/documentprocessing/pdf/acroforms/fieldsReturns all AcroForm fields of a given PDF document.
POST/documentprocessing/barcodes/createCreates a barcode image.
GET/documentprocessing/barcodes/defaulttextReturns the default text of a given barcode type.
GET/documentprocessing/barcodes/maximumtextlengthReturns the maximum text length that can be encoded.
GET/documentprocessing/barcodes/minimumtextlengthReturns the minimum text length that can be encoded.
GET/documentprocessing/barcodes/istextvalidChecks whether a text can be encoded with a given barcode type.