Migrate from earlier versions of the Web Services API - ABBYY Documentation

The new version of the Web Services API is not compatible with earlier versions of WSDL. The following changes are implemented in the new version.

API method changes

Method	Change
AddNewDocument	Added the `previousItemId` parameter that makes it possible to specify the position of a new document in a set.
AddNewPage	Added the `previousItemId` parameter that makes it possible to specify the position of a page document in a set.
CreateTask	Added the `batchId` parameter for passing the identifier of the batch to which a document belongs.
GetBatchIdsRange	This new method reserves a range of identifiers within a batch.
GetDocument	Added the `sessionId` parameter for passing the identifiers of Application Server connection sessions.
GetDocumentResultsList	Added the `sessionId` parameter for passing the identifiers of Application Server connection sessions, and the `batchId` parameter for passing the identifier of the batch to which a document belongs.
GetDocuments	This method now returns a list containing all documents, including the empty document that is the parent document of all the top-level documents in the batch. It also adds the `sessionId` parameter for passing the identifiers of Application Server connection sessions.
LoadDocumentResult	Added the `sessionId` parameter for passing the identifiers of Application Server connection sessions, and the `batchId` parameter for passing the identifier of the batch to which a document belongs.
ReplacePageImage	Added the `batchId` parameter for passing the identifier of the batch to which a document belongs.
SetDocumentPriority	Added the `batchId` parameter for passing the identifier of the batch to which a document belongs.

Data type changes

Data type	Change
ChildrenOrder	This new structure contains information about a child document of a set.
Document	Added the `ParentId` field, which contains the identifier of the parent document of a set. It also adds the `ChildrenOrder` field for passing a set of child documents, which makes it possible to sort documents in a set.
Page	Removed the `PreviousId` field, because the value is now specified explicitly when a page is created using the AddNewPage method.

POST requests for files stored on a server must now include the parentId parameter.

Endpoints for the new version

Access the new version of the Web Services API at: https://<ApplicationServer>/FlexiCapture12/Server/API/v1/Soap The formal description is available at: https://<ApplicationServer>/FlexiCapture12/Server/API/v1/WSDL Earlier versions are not supported.