Navigation:  Integration via SOAP web services > Published web services > Capture >

getBatches

Previous  Top  Next

This method makes it possible to search for capturing batches.

 

Java class

Request

web/wwwroot/ws/java/capture/GetBatchesRequestType.java

Return

web/wwwroot/ws/java/capture/GetBatchesResponseType.java

 

Request

ID #

Required

Description

CaptureSettingID

 

Capture configuration ID #

BatchID

 

Batch ID #

BatchName

 

Batch title

BatchStep

 

Batch step:

1 - Capture;

2 - Quality control;

3 - Document separation;

4 - Recognition;

5 - Validation;

6 - Typing;

7 - Relationship;

8 - Verification;

9 - Indexing;

10 - Ended;

11 – Cancelled.

BeginInsertDate

 

Start of record date (format: yyyy-mm-dd)

EndInsertDate

 

End of record date (format: yyyy-mm-dd)

CreatorUserID

 

Record user ID

 

Return

ID #

Description

Status

FAILURE (in case of failure)

SUCCESS (in case of success)

Code

Error code:

0 - No error (record created successfully);

1 - Non-existent capture configuration;

2 - Non-existent record user;

3 - End date less than start date;

4 - Invalid value;

Detail

Message detailing the error or success in the execution of the method

Records

Search results:

Batches: Batches list

oCaptureSettingID: Capture configuration ID #;

oBatchID: Batch ID #;

oBatchName: Batch title;

oStartDate: Start date (format: yyyy-mm-dd);

oFinishDate: End date (format: yyyy-mm-dd);

oFileCount: Amount of files;

oBatchStep: Batch step:

1 - Capture;

2 - Quality control;

3 - Document separation;

4 - Recognition;

5 - Validation;

6 - Typing;

7 - Relationship;

8 - Verification;

9 - Indexing;

10 - Ended;

11 – Cancelled.