FAWAPIv2 Web Service

FAWAPIv2

Click here for a complete list of operations.

SetFolderProperties

Sets folder properties such as file version history and check-in/check-out.Please use the UpdateFolderProperties method. The SetFolderProperties method expires on April 24th 2020.

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

<?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>
    <SetFolderProperties xmlns="http://api.filesanywhere.com/">
      <Token>string</Token>
      <FolderPath>string</FolderPath>
      <Comments>string</Comments>
      <HasProperties>boolean</HasProperties>
      <VC_FLAG_FILE_VERSION>boolean</VC_FLAG_FILE_VERSION>
      <VC_FLAG_FILE_CHECKOUT>boolean</VC_FLAG_FILE_CHECKOUT>
      <VC_FLAG_FILE_DELETE>boolean</VC_FLAG_FILE_DELETE>
      <VC_FLAG_DAILY_EMAIL>boolean</VC_FLAG_DAILY_EMAIL>
      <VC_FLAG_UPDATE_EMAIL>boolean</VC_FLAG_UPDATE_EMAIL>
      <VC_FLAG_OWNER_EMAIL>boolean</VC_FLAG_OWNER_EMAIL>
      <VC_FLAG_GROUPSHARE_EMAIL>boolean</VC_FLAG_GROUPSHARE_EMAIL>
      <VC_EMAIL_TO>string</VC_EMAIL_TO>
      <RemoveChildProperties>boolean</RemoveChildProperties>
      <VersionKeepCount>int</VersionKeepCount>
      <SaveFlag>DetachFromParent or InheritFromParent or SaveProperties</SaveFlag>
    </SetFolderProperties>
  </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>
    <SetFolderPropertiesResponse xmlns="http://api.filesanywhere.com/">
      <SetFolderPropertiesResult>
        <ErrorMessage>string</ErrorMessage>
        <Updated>boolean</Updated>
      </SetFolderPropertiesResult>
    </SetFolderPropertiesResponse>
  </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>
    <SetFolderProperties xmlns="http://api.filesanywhere.com/">
      <Token>string</Token>
      <FolderPath>string</FolderPath>
      <Comments>string</Comments>
      <HasProperties>boolean</HasProperties>
      <VC_FLAG_FILE_VERSION>boolean</VC_FLAG_FILE_VERSION>
      <VC_FLAG_FILE_CHECKOUT>boolean</VC_FLAG_FILE_CHECKOUT>
      <VC_FLAG_FILE_DELETE>boolean</VC_FLAG_FILE_DELETE>
      <VC_FLAG_DAILY_EMAIL>boolean</VC_FLAG_DAILY_EMAIL>
      <VC_FLAG_UPDATE_EMAIL>boolean</VC_FLAG_UPDATE_EMAIL>
      <VC_FLAG_OWNER_EMAIL>boolean</VC_FLAG_OWNER_EMAIL>
      <VC_FLAG_GROUPSHARE_EMAIL>boolean</VC_FLAG_GROUPSHARE_EMAIL>
      <VC_EMAIL_TO>string</VC_EMAIL_TO>
      <RemoveChildProperties>boolean</RemoveChildProperties>
      <VersionKeepCount>int</VersionKeepCount>
      <SaveFlag>DetachFromParent or InheritFromParent or SaveProperties</SaveFlag>
    </SetFolderProperties>
  </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>
    <SetFolderPropertiesResponse xmlns="http://api.filesanywhere.com/">
      <SetFolderPropertiesResult>
        <ErrorMessage>string</ErrorMessage>
        <Updated>boolean</Updated>
      </SetFolderPropertiesResult>
    </SetFolderPropertiesResponse>
  </soap12:Body>
</soap12:Envelope>