Webservice: Split

splitting operations [Commercial editions only]

Index Method Request(s) Response Description
1 splitAllPages sid
docId
id splits a PDF document, each page in a different file
2 splitUsingBarcode sid
docId
expression
separator
id splits a PDF document using a barcode as separator
3 splitSelection sid
docId
expression
id splits a PDF document in a selection of pages
4 splitUsingText sid
docId
expression
separator
id splits a PDF document using a text as separator
5 splitUsingBlankPage sid
docId
separator
id splits a PDF document using a blank page as separator

Method #1: splitAllPages

splits a PDF document, each page in a different file

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y identifier of the document to split

Response

Name Type Required Multiple Description
     id
Long Y Y

Method #2: splitUsingBarcode

splits a PDF document using a barcode as separator

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y identifier of the document to split
     expression
String Y regular expression that must be matched by the barcode's value
     separator
Int Y how to handle the separator: 0 = skip, 1 = append to current segment, 2 = prepend to next segment

Response

Name Type Required Multiple Description
     id
Long Y Y

Method #3: splitSelection

splits a PDF document in a selection of pages

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y identifier of the document to split
     expression
String Y e.g.: 1,2,4-6,9

Response

Name Type Required Multiple Description
     id
Long Y Y

Method #4: splitUsingText

splits a PDF document using a text as separator

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y identifier of the document to split
     expression
String Y regular expression that must be matched by the text
     separator
Int Y how to handle the separator: 0 = skip, 1 = append to current segment, 2 = prepend to next segment

Response

Name Type Required Multiple Description
     id
Long Y Y

Method #5: splitUsingBlankPage

splits a PDF document using a blank page as separator

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y identifier of the document to split
     separator
Int Y how to handle the separator: 0 = skip, 1 = append to current segment, 2 = prepend to next segment

Response

Name Type Required Multiple Description
     id
Long Y Y