FAWAPI Web Service

FAWAPI

Click here for a complete list of operations.

FileAgingRule

Add/Edit File LifeCycle and Archive rule on a folder.

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

<?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>
    <FileAgingRule xmlns="http://api.filesanywhere.com/">
      <Token>string</Token>
      <Parameters>
        <AgingID>int</AgingID>
        <RuleName>string</RuleName>
        <FolderPath>string</FolderPath>
        <DeleteEmptySubFolder>boolean</DeleteEmptySubFolder>
        <Pattern>string</Pattern>
        <DeleteDays>int</DeleteDays>
        <StartDate>dateTime</StartDate>
        <ArchiveLocation>string</ArchiveLocation>
        <AgingType>FileLifeCycle or FileArchiveRule</AgingType>
        <AgingNotification>
          <NotificationAdvanceDays>int</NotificationAdvanceDays>
          <NotificationtoAllGroupShareUsers>boolean</NotificationtoAllGroupShareUsers>
          <ListGSUsers>
            <string>string</string>
            <string>string</string>
          </ListGSUsers>
          <AdditionalReceipient>string</AdditionalReceipient>
          <FolderOwner>boolean</FolderOwner>
        </AgingNotification>
        <Enable>boolean</Enable>
      </Parameters>
    </FileAgingRule>
  </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>
    <FileAgingRuleResponse xmlns="http://api.filesanywhere.com/">
      <FileAgingRuleResult>
        <AgingID>int</AgingID>
      </FileAgingRuleResult>
    </FileAgingRuleResponse>
  </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>
    <FileAgingRule xmlns="http://api.filesanywhere.com/">
      <Token>string</Token>
      <Parameters>
        <AgingID>int</AgingID>
        <RuleName>string</RuleName>
        <FolderPath>string</FolderPath>
        <DeleteEmptySubFolder>boolean</DeleteEmptySubFolder>
        <Pattern>string</Pattern>
        <DeleteDays>int</DeleteDays>
        <StartDate>dateTime</StartDate>
        <ArchiveLocation>string</ArchiveLocation>
        <AgingType>FileLifeCycle or FileArchiveRule</AgingType>
        <AgingNotification>
          <NotificationAdvanceDays>int</NotificationAdvanceDays>
          <NotificationtoAllGroupShareUsers>boolean</NotificationtoAllGroupShareUsers>
          <ListGSUsers>
            <string>string</string>
            <string>string</string>
          </ListGSUsers>
          <AdditionalReceipient>string</AdditionalReceipient>
          <FolderOwner>boolean</FolderOwner>
        </AgingNotification>
        <Enable>boolean</Enable>
      </Parameters>
    </FileAgingRule>
  </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>
    <FileAgingRuleResponse xmlns="http://api.filesanywhere.com/">
      <FileAgingRuleResult>
        <AgingID>int</AgingID>
      </FileAgingRuleResult>
    </FileAgingRuleResponse>
  </soap12:Body>
</soap12:Envelope>