FAWAPIv2 Web Service

FAWAPIv2

Click here for a complete list of operations.

SendFileShareLink

Shares files/folders securely with anyone, even non-members, using a web URL link. An email is sent by the system containing an encrypted web link, which when activated by recipients, will prompt them to Download the shared files or folders, or view files online, according to the parameters (options) given when calling the function. If the 'RecipientsEmailAddresses' element is equal to the value 'GENERALLINK', the function will return the FileShare URL Link without sending an email. This link can be used directly from any location, and the link behaves exactly like the way it does when sent in an email. Methods SendItemsELink, SendItemsELink2 and SendItemsELink3 will become obsolete once API clients migrate to SendFileShareLink method.

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

<?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>
    <SendFileShareLink xmlns="http://api.filesanywhere.com/">
      <Token>string</Token>
      <Parameters>
        <FileShareLinkItems>
          <Item>
            <Type>string</Type>
            <Path>string</Path>
          </Item>
          <Item>
            <Type>string</Type>
            <Path>string</Path>
          </Item>
        </FileShareLinkItems>
        <RecipientEmails>string</RecipientEmails>
        <FolderView>string</FolderView>
        <ShareDays>int</ShareDays>
        <RecordFileHistoryLog>string</RecordFileHistoryLog>
        <NotifyDownloadByEmail>string</NotifyDownloadByEmail>
        <SendReadReceipt>string</SendReadReceipt>
        <LinkInFileAttachment>string</LinkInFileAttachment>
        <ReadOnlyPermission>string</ReadOnlyPermission>
        <DownloadLimit>int</DownloadLimit>
        <DisplayWatermark>string</DisplayWatermark>
        <WatermarkAtCenter>string</WatermarkAtCenter>
        <WatermarkAtBottom>string</WatermarkAtBottom>
        <UserEmailAsSender>string</UserEmailAsSender>
        <EmailSubject>string</EmailSubject>
        <EmailBody>string</EmailBody>
        <LinkPassword>string</LinkPassword>
        <FlagCoverPage>string</FlagCoverPage>
        <CoverPageTitle>string</CoverPageTitle>
        <CoverPageMessage>string</CoverPageMessage>
        <ApprovalText>string</ApprovalText>
        <InputPromptMessage>string</InputPromptMessage>
        <SignaturePrompt>string</SignaturePrompt>
        <PlayOptions>string</PlayOptions>
        <DisplayUserName>boolean</DisplayUserName>
        <DisplayEmail>boolean</DisplayEmail>
        <DisplayComments>boolean</DisplayComments>
        <AddEmailInWaterMark>boolean</AddEmailInWaterMark>
        <AddFileShareIDInWaterMark>boolean</AddFileShareIDInWaterMark>
        <AddIPInWaterMark>boolean</AddIPInWaterMark>
        <AddTimeStampInWaterMark>boolean</AddTimeStampInWaterMark>
        <WaterMarkSize>int</WaterMarkSize>
        <WaterMarkColor>string</WaterMarkColor>
        <PasswordSecurity>int</PasswordSecurity>
      </Parameters>
    </SendFileShareLink>
  </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>
    <SendFileShareLinkResponse xmlns="http://api.filesanywhere.com/">
      <SendFileShareLinkResult />
    </SendFileShareLinkResponse>
  </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>
    <SendFileShareLink xmlns="http://api.filesanywhere.com/">
      <Token>string</Token>
      <Parameters>
        <FileShareLinkItems>
          <Item>
            <Type>string</Type>
            <Path>string</Path>
          </Item>
          <Item>
            <Type>string</Type>
            <Path>string</Path>
          </Item>
        </FileShareLinkItems>
        <RecipientEmails>string</RecipientEmails>
        <FolderView>string</FolderView>
        <ShareDays>int</ShareDays>
        <RecordFileHistoryLog>string</RecordFileHistoryLog>
        <NotifyDownloadByEmail>string</NotifyDownloadByEmail>
        <SendReadReceipt>string</SendReadReceipt>
        <LinkInFileAttachment>string</LinkInFileAttachment>
        <ReadOnlyPermission>string</ReadOnlyPermission>
        <DownloadLimit>int</DownloadLimit>
        <DisplayWatermark>string</DisplayWatermark>
        <WatermarkAtCenter>string</WatermarkAtCenter>
        <WatermarkAtBottom>string</WatermarkAtBottom>
        <UserEmailAsSender>string</UserEmailAsSender>
        <EmailSubject>string</EmailSubject>
        <EmailBody>string</EmailBody>
        <LinkPassword>string</LinkPassword>
        <FlagCoverPage>string</FlagCoverPage>
        <CoverPageTitle>string</CoverPageTitle>
        <CoverPageMessage>string</CoverPageMessage>
        <ApprovalText>string</ApprovalText>
        <InputPromptMessage>string</InputPromptMessage>
        <SignaturePrompt>string</SignaturePrompt>
        <PlayOptions>string</PlayOptions>
        <DisplayUserName>boolean</DisplayUserName>
        <DisplayEmail>boolean</DisplayEmail>
        <DisplayComments>boolean</DisplayComments>
        <AddEmailInWaterMark>boolean</AddEmailInWaterMark>
        <AddFileShareIDInWaterMark>boolean</AddFileShareIDInWaterMark>
        <AddIPInWaterMark>boolean</AddIPInWaterMark>
        <AddTimeStampInWaterMark>boolean</AddTimeStampInWaterMark>
        <WaterMarkSize>int</WaterMarkSize>
        <WaterMarkColor>string</WaterMarkColor>
        <PasswordSecurity>int</PasswordSecurity>
      </Parameters>
    </SendFileShareLink>
  </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>
    <SendFileShareLinkResponse xmlns="http://api.filesanywhere.com/">
      <SendFileShareLinkResult />
    </SendFileShareLinkResponse>
  </soap12:Body>
</soap12:Envelope>