getBatchData

Java class

Request

web/wwwroot/ws/java/capture/GetBatchDataRequestType.java

Return

web/wwwroot/ws/java/capture/GetBatchDataResponseType.java

Request

ID #

Required

Description

BatchID

X

Batch ID #

Return

ID #

Description

Status

FAILURE (in case of failure)

SUCCESS (in case of success)

Code

Error code:

•0 - No error (view performed successfully);

•1 - Inexistent batch;

•2 - This user does not have permission for this operation.

Detail

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

BatchData

Viewed batch data:

•CaptureSettingID: Capture configuration ID #;

•BatchID: Batch ID #;

•BatchName: Batch title;

•StartDate: Start date (format: yyyy-mm-dd);

•FinishDate: End date (format: yyyy-mm-dd);

•FileCount: Amount of files;

•BatchStep: Batch step:

o1 - Capture

o2 - Quality control

o3 - Document separation

o4 - Recognition

o5 - Validation

o6 - Typing

o7 - Relationship

o8 - Verification

o9 - Indexing

o10 - Ended

o11 – Cancelled

•BatchDocuments: Batch documents

oDocumentCode: Document code;

oCategoryID: Category ID #;

oDocumentID: Document ID #;

oDocumentTitle: Document title;

oFileCount: Number of files in the document;

oDocumentIndexes: Document indexes:

▪IndexName: Index name;

▪IndexValue: Index value;

oDocumentFiles:

▪FileCode: File code;

▪FileName: File name;

▪FileSize: File size;

▪FileURL: URL for file download;

▪FileIsBlank: Blank file: 1 - Yes; 2 - No;

▪FileIsInvalid: Invalid file: 1 - Yes; 2 - No;

•BatchFiles: Batch files:

oFileCode: File code;

oFileName: File name;

oFileSize: File size;

oFileURL: URL for file download;

oFileIsBlank: Blank file: 1 - Yes; 2 - No;

oFileIsInvalid: Invalid file: 1 - Yes; 2 - No;