newBatch

This method allows adding a new capture batch.

Java class
Request	web/wwwroot/ws/java/capture/NewBatchRequestType.java
Return	web/wwwroot/ws/java/capture/NewBatchResponseType.java

Request:

ID #	Required	Description
CaptureSettingID	X	Capture configuration ID #
BatchID		Capture batch ID #. If it is not entered, a sequential ID # will be generated.
BatchName		Batch title. If it is not entered, a sequential ID # will be generated based on the date/time of the batch creation.

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:capture">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:newBatch>
         <!--You may enter the following 3 items in any order-->
         <urn:CaptureSettingID>?</urn:CaptureSettingID>
         <urn:BatchID>?</urn:BatchID>
         <urn:BatchName>?</urn:BatchName>
      </urn:newBatch>
   </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 - Required parameter not entered or entered incorrectly; ▪ 2 - This user does not have permission for this operation; ▪ 3 - ID # already exists; ▪ 4 - Capture configuration not found;
Detail	Message detailing the error or success in the execution of the method.
RecordID	Created batch ID # (in case of success) or empty (in case of failure)