> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Migrate from earlier versions of the Web Services API

> Review the breaking changes between the new ABBYY FlexiCapture Web Services API and earlier WSDL versions, including updated methods, data types, and endpoints.

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](/flexi-capture/api/methods/add-new-document)           | Added the `previousItemId` parameter that makes it possible to specify the position of a new document in a set.                                                                                                                                                              |
| [AddNewPage](/flexi-capture/api/methods/add-new-page)                   | Added the `previousItemId` parameter that makes it possible to specify the position of a page document in a set.                                                                                                                                                             |
| [CreateTask](/flexi-capture/api/methods/create-task)                    | Added the `batchId` parameter for passing the identifier of the batch to which a document belongs.                                                                                                                                                                           |
| [GetBatchIdsRange](/flexi-capture/api/methods/get-batch-ids-range)      | This new method reserves a range of identifiers within a batch.                                                                                                                                                                                                              |
| [GetDocument](/flexi-capture/api/methods/get-document)                  | Added the `sessionId` parameter for passing the identifiers of Application Server connection sessions.                                                                                                                                                                       |
| [GetDocumentResultsList](/flexi-capture/get-document-results-list)      | 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](/flexi-capture/api/methods/get-documents)                | 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](/flexi-capture/api/methods/load-document-result)   | 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](/flexi-capture/api/methods/replace-page-image)       | Added the `batchId` parameter for passing the identifier of the batch to which a document belongs.                                                                                                                                                                           |
| [SetDocumentPriority](/flexi-capture/api/methods/set-document-priority) | Added the `batchId` parameter for passing the identifier of the batch to which a document belongs.                                                                                                                                                                           |

## Data type changes

| Data type                                                     | Change                                                                                                                                                                                                                      |
| ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [ChildrenOrder](/flexi-capture/api/structures/children-order) | This new structure contains information about a child document of a set.                                                                                                                                                    |
| [Document](/flexi-capture/api/structures/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](/flexi-capture/api/structures/page)                    | Removed the `PreviousId` field, because the value is now specified explicitly when a page is created using the [AddNewPage](/flexi-capture/api/methods/add-new-page) method.                                                |

POST requests for [files](/flexi-capture/api/files/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.