FAWAPI Web Service

FAWAPI

Click here for a complete list of operations.

AdminUserAdd

This operation lets the Private Site Administrator add a new 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.filesanywhere.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.filesanywhere.com/AdminUserAdd"

<?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>
    <AdminUserAdd xmlns="http://api.filesanywhere.com/">
      <AdminAuthParameters>
        <APIKey>string</APIKey>
        <OrgID>long</OrgID>
        <AdminUserID>string</AdminUserID>
        <AdminPassword>string</AdminPassword>
      </AdminAuthParameters>
      <Parameters>
        <PersonalInformation>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Email>string</Email>
          <CompanyName>string</CompanyName>
          <JobTitle>string</JobTitle>
          <Phone>string</Phone>
          <CellPhone>string</CellPhone>
          <Address>string</Address>
          <City>string</City>
          <State>string</State>
          <ZipCode>string</ZipCode>
          <Country>string</Country>
          <Notes>string</Notes>
        </PersonalInformation>
        <SSO>
          <SSOAuthenticationType>NonSSO or SSOOnly or MixedSSO</SSOAuthenticationType>
          <UserPrincipalName>string</UserPrincipalName>
        </SSO>
        <UserDetail>
          <UserName>string</UserName>
          <Password>string</Password>
          <DoNotEmailDetailsToUser>boolean</DoNotEmailDetailsToUser>
          <DivisionCode>string</DivisionCode>
          <RegionName>string</RegionName>
          <PersonalStorage>boolean</PersonalStorage>
          <StorageSize>int</StorageSize>
        </UserDetail>
        <ShareFolder>
          <FolderPath>string</FolderPath>
          <Permission>string</Permission>
          <SharedByUsername>string</SharedByUsername>
          <SharedToUsername>string</SharedToUsername>
          <ExpirationDate>dateTime</ExpirationDate>
        </ShareFolder>
        <AdvancedUserDetail>
          <LockUserProfile>boolean</LockUserProfile>
          <LogAllDownloadActivity>boolean</LogAllDownloadActivity>
          <PurgeFileDays>int</PurgeFileDays>
          <EnableFTP>boolean</EnableFTP>
          <EnableSFTP>boolean</EnableSFTP>
          <EnableWEBDAV>boolean</EnableWEBDAV>
          <FTPHomeFolderPath>string</FTPHomeFolderPath>
          <SFTPHomeFolderPath>string</SFTPHomeFolderPath>
          <WEBDAVHomeFolderPath>string</WEBDAVHomeFolderPath>
        </AdvancedUserDetail>
      </Parameters>
    </AdminUserAdd>
  </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>
    <AdminUserAddResponse xmlns="http://api.filesanywhere.com/">
      <AdminUserAddResult>
        <UserName>string</UserName>
      </AdminUserAddResult>
    </AdminUserAddResponse>
  </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>
    <AdminUserAdd xmlns="http://api.filesanywhere.com/">
      <AdminAuthParameters>
        <APIKey>string</APIKey>
        <OrgID>long</OrgID>
        <AdminUserID>string</AdminUserID>
        <AdminPassword>string</AdminPassword>
      </AdminAuthParameters>
      <Parameters>
        <PersonalInformation>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <Email>string</Email>
          <CompanyName>string</CompanyName>
          <JobTitle>string</JobTitle>
          <Phone>string</Phone>
          <CellPhone>string</CellPhone>
          <Address>string</Address>
          <City>string</City>
          <State>string</State>
          <ZipCode>string</ZipCode>
          <Country>string</Country>
          <Notes>string</Notes>
        </PersonalInformation>
        <SSO>
          <SSOAuthenticationType>NonSSO or SSOOnly or MixedSSO</SSOAuthenticationType>
          <UserPrincipalName>string</UserPrincipalName>
        </SSO>
        <UserDetail>
          <UserName>string</UserName>
          <Password>string</Password>
          <DoNotEmailDetailsToUser>boolean</DoNotEmailDetailsToUser>
          <DivisionCode>string</DivisionCode>
          <RegionName>string</RegionName>
          <PersonalStorage>boolean</PersonalStorage>
          <StorageSize>int</StorageSize>
        </UserDetail>
        <ShareFolder>
          <FolderPath>string</FolderPath>
          <Permission>string</Permission>
          <SharedByUsername>string</SharedByUsername>
          <SharedToUsername>string</SharedToUsername>
          <ExpirationDate>dateTime</ExpirationDate>
        </ShareFolder>
        <AdvancedUserDetail>
          <LockUserProfile>boolean</LockUserProfile>
          <LogAllDownloadActivity>boolean</LogAllDownloadActivity>
          <PurgeFileDays>int</PurgeFileDays>
          <EnableFTP>boolean</EnableFTP>
          <EnableSFTP>boolean</EnableSFTP>
          <EnableWEBDAV>boolean</EnableWEBDAV>
          <FTPHomeFolderPath>string</FTPHomeFolderPath>
          <SFTPHomeFolderPath>string</SFTPHomeFolderPath>
          <WEBDAVHomeFolderPath>string</WEBDAVHomeFolderPath>
        </AdvancedUserDetail>
      </Parameters>
    </AdminUserAdd>
  </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>
    <AdminUserAddResponse xmlns="http://api.filesanywhere.com/">
      <AdminUserAddResult>
        <UserName>string</UserName>
      </AdminUserAddResult>
    </AdminUserAddResponse>
  </soap12:Body>
</soap12:Envelope>