newBatchFile
This method allows adding a new file into a capture batch.
Java class | |
---|---|
Request | web/wwwroot/ws/java/capture/NewBatchFileRequestType.java |
Return | web/wwwroot/ws/java/capture/NewBatchFileResponseType.java |
Request:
ID # | Required | Description |
---|---|---|
BatchID | X | Capture batch ID # |
FileName | X | File name |
FileContent | X | File 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 |
---|---|
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 - Batch not found; â–ª 4 - Invalid file type for the capture configuration; â–ª 5 - Batch step does not allow adding a new file; |
Detail | Message detailing the error or success in the execution of the method. |
RecordID | Code of created file (in case of success) or empty (in case of failure) |