Skip to main content
Version: 2.2.1

setIndexValue

This method allows filling out the value of an index related to a document from the capture batch.

Java class
Requestweb/wwwroot/ws/java/capture/SetIndexValueRequestType.java
Returnweb/wwwroot/ws/java/capture/SetIndexValueResponseType.java

Request:

ID #RequiredDescription
BatchIDXBatch ID #
DocumentCodeXBatch document code
IndexNameXIndex name
IndexValueIndex value

Request structure:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:capture">
<soapenv:Header/>
<soapenv:Body>
<urn:setIndexValue>
<!--You may enter the following 4 items in any order-->
<urn:BatchID>?</urn:BatchID>
<urn:DocumentCode>?</urn:DocumentCode>
<urn:IndexName>?</urn:IndexName>
<urn:IndexValue>?</urn:IndexValue>
</urn:setIndexValue>
</soapenv:Body>
</soapenv:Envelope>

Return:

ID #Description
StatusFAILURE (in case of failure)
SUCCESS (in case of success)
CodeError code:
• 0 - No error (search performed successfully);
• 1 - Inexistent batch;
• 2 - Document not found;
• 3 - Inexistent index;
• 4 - This user does not have permission for this operation;
• 5 - Batch step does not allow completion
DetailMessage detailing the error or success in the execution of the method.