FAWAPI


Click here for a complete list of operations.

FileShareRequestDocIndexing

Sends the system a request to index the referenced file. The system processes these requests in a queue. Once the document pages are indexed for viewing, the ItemImage function may be called to return the page image(s) in the file.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /fawapi.asmx HTTP/1.1
Host: api.filesanywhere.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.filesanywhere.com/FileShareRequestDocIndexing"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <FileShareRequestDocIndexing xmlns="http://api.filesanywhere.com/">
      <FSToken>string</FSToken>
      <ItemsToIndex>
        <Item>
          <Path>string</Path>
        </Item>
        <Item>
          <Path>string</Path>
        </Item>
      </ItemsToIndex>
    </FileShareRequestDocIndexing>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <FileShareRequestDocIndexingResponse xmlns="http://api.filesanywhere.com/">
      <DocIndexingResult>
        <ErrorMessage>string</ErrorMessage>
        <SuccessCount>int</SuccessCount>
      </DocIndexingResult>
    </FileShareRequestDocIndexingResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /fawapi.asmx HTTP/1.1
Host: api.filesanywhere.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <FileShareRequestDocIndexing xmlns="http://api.filesanywhere.com/">
      <FSToken>string</FSToken>
      <ItemsToIndex>
        <Item>
          <Path>string</Path>
        </Item>
        <Item>
          <Path>string</Path>
        </Item>
      </ItemsToIndex>
    </FileShareRequestDocIndexing>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <FileShareRequestDocIndexingResponse xmlns="http://api.filesanywhere.com/">
      <DocIndexingResult>
        <ErrorMessage>string</ErrorMessage>
        <SuccessCount>int</SuccessCount>
      </DocIndexingResult>
    </FileShareRequestDocIndexingResponse>
  </soap12:Body>
</soap12:Envelope>