FAWAPI Web Service

FAWAPI

Click here for a complete list of operations.

FileShareItemImage

Displays an image of the referenced page within the referenced file. This function only returns an image if the file is done indexing.

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/FileShareItemImage"

<?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>
    <FileShareItemImage xmlns="http://api.filesanywhere.com/">
      <FSToken>string</FSToken>
      <Type>string</Type>
      <Path>string</Path>
      <PageNumber>long</PageNumber>
      <DesiredImageHeight>int</DesiredImageHeight>
      <DesiredImageWidth>int</DesiredImageWidth>
      <ZoomPercent>int</ZoomPercent>
    </FileShareItemImage>
  </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>
    <FileShareItemImageResponse xmlns="http://api.filesanywhere.com/">
      <ItemImageResult>
        <ErrorMessage>string</ErrorMessage>
        <FilePath>string</FilePath>
        <ImageStream>base64Binary</ImageStream>
      </ItemImageResult>
    </FileShareItemImageResponse>
  </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>
    <FileShareItemImage xmlns="http://api.filesanywhere.com/">
      <FSToken>string</FSToken>
      <Type>string</Type>
      <Path>string</Path>
      <PageNumber>long</PageNumber>
      <DesiredImageHeight>int</DesiredImageHeight>
      <DesiredImageWidth>int</DesiredImageWidth>
      <ZoomPercent>int</ZoomPercent>
    </FileShareItemImage>
  </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>
    <FileShareItemImageResponse xmlns="http://api.filesanywhere.com/">
      <ItemImageResult>
        <ErrorMessage>string</ErrorMessage>
        <FilePath>string</FilePath>
        <ImageStream>base64Binary</ImageStream>
      </ItemImageResult>
    </FileShareItemImageResponse>
  </soap12:Body>
</soap12:Envelope>