Skip to main content
Version: 2.2.3

newBatchFile

This method allows adding a new file into a capture batch.

Java class
Requestweb/wwwroot/ws/java/capture/NewBatchFileRequestType.java
Returnweb/wwwroot/ws/java/capture/NewBatchFileResponseType.java

Request:

ID #RequiredDescription
BatchIDXCapture batch ID #
FileNameXFile name
FileContentXFile content that must be added

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:capture">
<soapenv:Header/>
<soapenv:Body>
<urn:newBatchFile>
<!--You may enter the following 3 items in any order-->
<urn:BatchID>?</urn:BatchID>
<urn:FileName>?</urn:FileName>
<urn:FileContent>cid:323955913506</urn:FileContent>
</urn:newBatchFile>
</soapenv:Body>
</soapenv:Envelope>

Return:

ID #Description
StatusFAILURE (in case of failure)
SUCCESS (in case of success)
CodeError 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 - Batch not found;
▪ 4 - Invalid file type for the capture configuration;
▪ 5 - Batch step does not allow adding a new file;
DetailMessage detailing the error or success in the execution of the method.
RecordIDCode of created file (in case of success) or empty (in case of failure)