Api specifications

SendELinkResult Properties

SendItemsELink3

Syntax

SendElinkResult= SendItemsELink3(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,DisplayUserName,DisplayEmailAddress)

Usage

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

The following parameters are needed to make the SendItemsELink3 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).
  
• 
  DisplayUserName. (Flag indicating to display the user’s name).
  
• 
  DisplayEmailAddress. (Flag indicating to display the user’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/SendItemsELink3"








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

SendELinkResult Properties

SetAccountDetails

Syntax

SetAccountDetails = SetAccountDetails(Token,EmailAddress,OldPassword,NewPassword)

Usage

Use the SetAccountDetails method to set account properties.

The following parameters are needed to make the SetAccountDetails call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  EmailAddress. (The user’s email address).
  
• 
  OldPassword. (The user’s current password).
  
• 
  NewPassword. (The user’s new password).
  

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








string

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

string

HTTP/1.1 200 OK

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

Content-Length: length

Request Arguments

SetAccountDetailsResultv2

SetAccountDetailsResultv2 Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the SetAccountDetails method was executed. If the SetAccountDetails call was successful, the ErrorMessage is blank

SetAPNSetting

Syntax

SetAPNSettingResult = SetAPNSetting (Token,NotificationType,Setting)

Usage

Use the SetAPNSetting method to retrieve a list of notification type and their current settings for the logged on user.

The following parameters are needed to make the SetAPNSetting call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  NotificationType (The type of notification, listed in the NotificationTypes enum)
  
• 
  Setting (“Y” := on/enabled, “N” :=off/disabled)