setIndexValue

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

Java class
Request	web/wwwroot/ws/java/capture/SetIndexValueRequestType.java
Return	web/wwwroot/ws/java/capture/SetIndexValueResponseType.java

Request:

ID #	Required	Description
BatchID	X	Batch ID #
DocumentCode	X	Batch document code
IndexName	X	Index name
IndexValue		Index 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
Status	FAILURE (in case of failure) SUCCESS (in case of success)
Code	Error 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
Detail	Message detailing the error or success in the execution of the method.