getBatchData
This method allows viewing all data from a capture batch.
| 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 # |
Request structure:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:capture">
<soapenv:Header/>
<soapenv:Body>
<urn:getBatchData>
<urn:BatchID>?</urn:BatchID>
</urn:getBatchData>
</soapenv:Body>
</soapenv:Envelope>
Return:
| ID # | Description |
|---|---|
| Status | FAILURE (in case of failure) SUCCESS (in case of success) |
| Code | Error code: • 0 - No error (search 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: o 1 - Capture o 2 - Quality control o 3 - Document separation o 4 - Recognition o 5 - Validation o 6 - Typing o 7 - Relationship o 8 - Verification o 9 - Indexing o 10 - Ended o 11 – Cancelled • BatchDocuments: Batch documents o DocumentCode: Document code; o CategoryID: Category ID #; o DocumentID: Document ID #; o DocumentTitle: Document title; o FileCount: Number of files in the document; o DocumentIndexes: Document indexes: ▪ IndexName: Index name; ▪ IndexValue: Index value; o DocumentFiles: ▪ 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: o FileCode: File code; o FileName: File name; o FileSize: File size; o FileURL: URL for file download; o FileIsBlank: Blank file: 1 - Yes; 2 - No; o FileIsInvalid: Invalid file: 1 - Yes; 2 - No. |