FAWAPIv2 Web Service

FAWAPIv2

Click here for a complete list of operations.

SearchFiles

Searches for files and folders by name, content within files, and comments and tags.

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 /v2/fawapi.asmx HTTP/1.1
Host: api.filesanywhere.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.filesanywhere.com/SearchFiles"

<?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>
    <SearchFiles xmlns="http://api.filesanywhere.com/">
      <Token>string</Token>
      <Path>string</Path>
      <MP>string</MP>
      <ItemName>string</ItemName>
      <TextInFile>string</TextInFile>
      <Comments>string</Comments>
      <Tag>string</Tag>
      <SizeUnit>None or KiloBytes or MegaBytes or GigaBytes</SizeUnit>
      <SizeFrom>long</SizeFrom>
      <SizeTo>long</SizeTo>
      <DateFrom>dateTime</DateFrom>
      <DateTo>dateTime</DateTo>
      <CheckFolderName>boolean</CheckFolderName>
      <CheckSubFolders>boolean</CheckSubFolders>
      <CheckIndex>boolean</CheckIndex>
      <SortBy>NAME or TYPETEXT or MODIFIEDDATE or SIZE</SortBy>
      <SortOrder>ASC or DESC</SortOrder>
      <StartPage>int</StartPage>
      <PageSize>int</PageSize>
    </SearchFiles>
  </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>
    <SearchFilesResponse xmlns="http://api.filesanywhere.com/">
      <SearchFilesResult>
        <ErrorMessage>string</ErrorMessage>
        <Items>
          <CAddListItem>
            <Folder>string</Folder>
            <ModifiedDate>dateTime</ModifiedDate>
            <Size>unsignedLong</Size>
            <Name>string</Name>
            <Parameter>string</Parameter>
            <TotalSize>long</TotalSize>
            <ItemType>string</ItemType>
            <FileID>string</FileID>
            <SortField>string</SortField>
          </CAddListItem>
          <CAddListItem>
            <Folder>string</Folder>
            <ModifiedDate>dateTime</ModifiedDate>
            <Size>unsignedLong</Size>
            <Name>string</Name>
            <Parameter>string</Parameter>
            <TotalSize>long</TotalSize>
            <ItemType>string</ItemType>
            <FileID>string</FileID>
            <SortField>string</SortField>
          </CAddListItem>
        </Items>
      </SearchFilesResult>
    </SearchFilesResponse>
  </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 /v2/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>
    <SearchFiles xmlns="http://api.filesanywhere.com/">
      <Token>string</Token>
      <Path>string</Path>
      <MP>string</MP>
      <ItemName>string</ItemName>
      <TextInFile>string</TextInFile>
      <Comments>string</Comments>
      <Tag>string</Tag>
      <SizeUnit>None or KiloBytes or MegaBytes or GigaBytes</SizeUnit>
      <SizeFrom>long</SizeFrom>
      <SizeTo>long</SizeTo>
      <DateFrom>dateTime</DateFrom>
      <DateTo>dateTime</DateTo>
      <CheckFolderName>boolean</CheckFolderName>
      <CheckSubFolders>boolean</CheckSubFolders>
      <CheckIndex>boolean</CheckIndex>
      <SortBy>NAME or TYPETEXT or MODIFIEDDATE or SIZE</SortBy>
      <SortOrder>ASC or DESC</SortOrder>
      <StartPage>int</StartPage>
      <PageSize>int</PageSize>
    </SearchFiles>
  </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>
    <SearchFilesResponse xmlns="http://api.filesanywhere.com/">
      <SearchFilesResult>
        <ErrorMessage>string</ErrorMessage>
        <Items>
          <CAddListItem>
            <Folder>string</Folder>
            <ModifiedDate>dateTime</ModifiedDate>
            <Size>unsignedLong</Size>
            <Name>string</Name>
            <Parameter>string</Parameter>
            <TotalSize>long</TotalSize>
            <ItemType>string</ItemType>
            <FileID>string</FileID>
            <SortField>string</SortField>
          </CAddListItem>
          <CAddListItem>
            <Folder>string</Folder>
            <ModifiedDate>dateTime</ModifiedDate>
            <Size>unsignedLong</Size>
            <Name>string</Name>
            <Parameter>string</Parameter>
            <TotalSize>long</TotalSize>
            <ItemType>string</ItemType>
            <FileID>string</FileID>
            <SortField>string</SortField>
          </CAddListItem>
        </Items>
      </SearchFilesResult>
    </SearchFilesResponse>
  </soap12:Body>
</soap12:Envelope>