FAWAPI Web Service

FAWAPI

Click here for a complete list of operations.

GroupShareAdd

Create a new GroupShare: shares a folder from the active session user account to a different user.

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.file-assist.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.file-assist.com/GroupShareAdd"

<?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>
    <GroupShareAdd xmlns="http://api.file-assist.com/">
      <Token>string</Token>
      <UserAccountWithWhomToShareFolder>string</UserAccountWithWhomToShareFolder>
      <SharedFolderName>string</SharedFolderName>
      <SharedFolderAccessLevel>string</SharedFolderAccessLevel>
      <Notes>string</Notes>
    </GroupShareAdd>
  </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>
    <GroupShareAddResponse xmlns="http://api.file-assist.com/">
      <GroupShareAddResult>
        <ErrorMessage>string</ErrorMessage>
        <GroupShareCreated>boolean</GroupShareCreated>
      </GroupShareAddResult>
    </GroupShareAddResponse>
  </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.file-assist.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>
    <GroupShareAdd xmlns="http://api.file-assist.com/">
      <Token>string</Token>
      <UserAccountWithWhomToShareFolder>string</UserAccountWithWhomToShareFolder>
      <SharedFolderName>string</SharedFolderName>
      <SharedFolderAccessLevel>string</SharedFolderAccessLevel>
      <Notes>string</Notes>
    </GroupShareAdd>
  </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>
    <GroupShareAddResponse xmlns="http://api.file-assist.com/">
      <GroupShareAddResult>
        <ErrorMessage>string</ErrorMessage>
        <GroupShareCreated>boolean</GroupShareCreated>
      </GroupShareAddResult>
    </GroupShareAddResponse>
  </soap12:Body>
</soap12:Envelope>