Api specifications

SearchFilesResult Properties

To search for files in all the GroupShare folders, user has to perform below steps

1. 
   Call ListUserVolumns2 API function which will return all the root folder names including shared folders.
   
2. 
   Call SearchFiles API function to search files in each GroupShare folder path that were returned in the above function call and club the results.
   

Syntax

SendElinkResult= SendDropboxLink2(Token,DropFolderPath,RecipientEmailAddresses,ShareDays,RecordFileHistoryLog,NotifyDownloadByEmail,SendReadReceipt,LinkInFileAttachment,OverWriteFiles,SubFolderNamePrompt,UserEmailAsSender,EmailSubject,EmailBody,ElinkPassWord,RedirectURL,RedirectText,DisplayName,DisplayEmailAddress)

Usage

Use the SendDropboxLink2 method to create and send a FileReceive Link.

The following parameters are needed to make the SendDropboxLink2 call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  DropFolderPath. (The path to the folder where the FileReceive Link will exist).
  
• 
  RecipientEmailAddresses. (List of email addresses to send the FileReceive Link to).
  
• 
  ShareDays. (Number of days the FileReceive Link will be active).
  
• 
  RecordFileHistoryLog. (Flag indicating to log file activity).
  
• 
  NotifyDownloadByEmail. (Flag indicating an email notification to be sent to recipients).
  
• 
  SendReadReceipt. (Flag indicating a read receipt should be generated for the email notification when it is read).
  
• 
  LinkInFileAttachment. ()
  
• 
  OverWriteFiles. (Flag indicating files can be overwritten).
  
• 
  SubFolderNamePrompt. (Text displayed to create a user partition in the FileReceive Link for each user).
  
• 
  UserEmailAsSender. (Flag indicating to send email notifications from the system email account or the user’s email account).
  
• 
  EmailSubject. (The subject line of the email notification).
  
• 
  EmailBody. (The body of the email notification).
  
• 
  ElinkPassWord. (The password assigned to the FileReceive Link).
  
• 
  RedirectURL. (The URL to return the user to).
  
• 
  RedirectText. (The text displayed to redirect the user back to a provided URL).
  
• 
  DisplayName. (Flag indicating to display the FileReceive Link owner’s name).
  
• 
  DisplayEmailAddress. (Flag indicating to display the FileReceive Link owner’s email address).
  

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








string

string

string

int

string

string

string

string

string

string

string

string

string

string

string

string

boolean

boolean

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

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








string

string

string

int

string

string

string

string

string

string

string

string

string

string

string

string

boolean

boolean






HTTP/1.1 200 OK

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length






Response xmlns="http://api.filesanywhere.com/">



string

boolean





string





string

Request Arguments

SendELinkResult Properties

SendItemsELink2

Syntax

SendElinkResult= SendItemsELink2(Token, ELinkItems,RecipientEmailAddresses,FolderView,ShareDays,RecordFileHistoryLog,NotifyDownloadByEmail,SendReadReceipt,LinkInFileAttachment,ReadOnlyPermission, DownloadLimit,DisplayWatermark,WatermarkAtCenter,WatermarkAtBottom,UserEmailAsSender,EmailSubject,EmailBody,ElinkPassWord,sFLAG_COVER_PAGE,sCP_TITLE,sCP_MESSAGE,sCHECKBOX_APPROVAL_TEXT,sINPUT_PROMPT_MESSAGE,sSIGNATURE_PROMPT,sFS_PLAY_OPTIONS)

Usage

Use the SendItemsELink2 method to create and send a FileShare link.

The following parameters are needed to make the SendItemsELink2 call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  ELinkItems. (Array of items to include in the FileShare).
  
• 
  RecipientEmailAddresses. (List of email addresses to send the FileShare link to).
  
• 
  FolderView. (Flag indicating the type of view to display).
  
• 
  ShareDays. (Number of days the FileShare link will be active).
  
• 
  RecordFileHistoryLog. (Flag indicating to log file activity).
  
• 
  NotifyDownloadByEmail. (Flag indicating an email notification to be sent to recipients).
  
• 
  SendReadReceipt. (Flag indicating a read receipt should be generated for the email notification when it is read).
  
• 
  LinkInFileAttachment. ()
  
• 
  ReadOnlyPermission. (Flag indicating files can be downloaded or only viewed).
  
• 
  DownloadLimit. (Maximum number of downloads for the FileShare).
  
• 
  DisplayWatermark. (Flag indicating the file should be watermarked).
  
• 
  WatermarkAtCenter. (Text displayed in the center watermark).
  
• 
  WatermarkAtBottom. (Text displayed in the bottom watermark).
  
• 
  UserEmailAsSender. (Flag indicating to send email notifications from the system email account or the user’s email account).
  
• 
  EmailSubject. (The subject line of the email notification).
  
• 
  EmailBody. (The body of the email notification).
  
• 
  ElinkPassWord. (The password assigned to the FileShare Link).
  
• 
  sFLAG_COVER_PAGE. (Flag indicating the FileShare has a cover page).
  
• 
  sCP_TITLE. (Title text for the cover page).
  
• 
  sCP_MESSAGE. (Message text for the cover page).
  
• 
  sCHECKBOX_APPROVAL_TEXT. (Text to display to obtain the user’s approval).
  
• 
  sINPUT_PROMPT_MESSAGE. (Text to display to obtain input from the user).
  
• 
  sSIGNATURE_PROMPT. (Text to display to obtain the user’s signature).
  
• 
  sFS_PLAY_OPTIONS. (Flag indicating the play options for the FileShare).
  

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








string





string

string

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

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








string





string

string

HTTP/1.1 200 OK

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

Request Arguments