getBatches

Java class
Request	web/wwwroot/ws/java/capture/GetBatchesRequestType.java
Return	web/wwwroot/ws/java/capture/GetBatchesResponseType.java

This method allows searching for capturing batches.

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

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:capture">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:getBatches>
         <!--You may enter the following 7 items in any order-->
         <urn:CaptureSettingID>?</urn:CaptureSettingID>
         <urn:BatchID>?</urn:BatchID>
         <urn:BatchName>?</urn:BatchName>
         <urn:BatchStep>?</urn:BatchStep>
         <urn:BeginInsertDate>?</urn:BeginInsertDate>
         <urn:EndInsertDate>?</urn:EndInsertDate>
         <urn:CreatorUserID>?</urn:CreatorUserID>
      </urn:getBatches>
   </soapenv:Body>
</soapenv:Envelope>

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 o CaptureSettingID: Capture configuration ID #; o BatchID: Batch ID #; o BatchName: Batch title; o StartDate: Start date (format: yyyy-mm-dd); o FinishDate: End date (format: yyyy-mm-dd); o FileCount: Amount of files; o 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.