Api specifications

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

HTTP/1.1 200 OK

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

Content-Length: length

Request Arguments

SetDropBoxDefaultsResultv2

SetDropBoxDefaultsResultv2 Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the SetAPNSetting method was executed. If the SetAPNSetting call was successful, the ErrorMessage is blank
Updated	Boolean	Indicates the default settings were updated.

SetDropBoxDefaults2

Syntax

SetDropBoxDefaultsResult = SetDropBoxDefaults2 (Token,ShareDays,FlagLog,FlagEmail,FlagEmailFromSystem,EmailSubject,EmailBody,FlagAttachment,FlagReadReceipt,FlagOverwrite,SubFolderNamePrompt,ReturnLinkLabel,ReturnLinkURL, ShowName, ShowEmailAddress)

Usage

Use the SetDropBoxDefaults method to set the default settings for creating a FileReceive Link.

The following parameters are needed to make the SetDropBoxDefaults call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  ShareDays. (The number of days the FileReceive Link will remain active).
  
• 
  FlagLog. (Flag indicating logging of activity to FileReceive Link).
  
• 
  FlagEmail. (Flag indicating an email notification should be sent to recipients).
  
• 
  FlagEmailFromSystem. (Flag indicating the email notification should be sent from the system email account or the user’s email account).
  
• 
  EmailSubject. (Email notification subject).
  
• 
  EmailBody. (Email notification text).
  
• 
  FlagAttachment. ()
  
• 
  FlagReadReceipt. (Flag indicating a read receipt should be generated when email notifications are read).
  
• 
  FlagOverwrite. (Flag indicating files in the FileReceive Link can be overwritten).
  
• 
  SubFolderNamePrompt. (Text to display when partitioning a FileReceive Link for each user).
  
• 
  ReturnLinkLabel. (Text to display to return the user to another URL).
  
• 
  ReturnLinkURL. (URL to return the user to).
  
• 
  ShowName. (Flag indicating to show the name of the owner of the FileReceive Link).
  
• 
  ShowEmailAddress. (Flag indicating to show the email address of the owner of the FileReceive Link).
  

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








string

int

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

int

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

Request Arguments

SetDropBoxDefaultsResultv2

SetDropBoxDefaultsResultv2 Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the SetAPNSetting method was executed. If the SetAPNSetting call was successful, the ErrorMessage is blank
Updated	Boolean	Indicates the default settings were updated.

SetELinkDefaults

Syntax

SetELinkDefaultsResult = SetELinkDefaults (Token,ShareDays,FlagLog,FlagEmail,FlagMediaView,FlagPlayOptions,DownloadLimit,FlagViewOnly,FlagWatermark,WatermarkCenter,WatermarkBottom,FlagEmailFromSystem,EmailSubject,EmailBody,FlagReadReceipt,FlagCoverPage,CoverPageTitle,CoverPageMessage,ApprovalText,InputPromptText,SignaturePromptText)

Usage

Use the SetELinkDefaults method to set the default settings for creating a FileShare link.

The following parameters are needed to make the SetELinkDefaults call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  ShareDays. (The number of days the FileReceive Link will remain active).
  
• 
  FlagLog. (Flag indicating logging of activity to FileReceive Link).
  
• 
  FlagEmail. (Flag indicating an email notification should be sent to recipients).
  
• 
  FlagMediaView. (Flag indicating the type of view for the FileShare).
  
• 
  FlagPlayOptions. (Flag indicating the play options for the FileShare).
  
• 
  DownloadLimit. (The maximum number of downloads for the FileShare).
  
• 
  FlagViewOnly. (Flag specifying if files can be downloaded or view-only).
  
• 
  FlagWatermark. (Flag indicating the FileShare has a watermark).
  
• 
  WatermarkCenter. (Text displayed in the center watermark).
  
• 
  WatermarkBottom. (Text displayed in the bottom watermark).
  
• 
  FlagEmailFromSystem. (Flag indicating the email notification should be sent from the system email account or the user’s email account).
  
• 
  EmailSubject. (Email notification subject).
  
• 
  EmailBody. (Email notification text).
  
• 
  FlagReadReceipt. (Flag indicating a read receipt should be generated when email notifications are read).
  
• 
  FlagCoverPage. (Flag indicating the FileShare has a cover page).
  
• 
  CoverPageTitle. (Title text for the cover page).
  
• 
  CoverPageMessage. (Message text for the cover page).
  
• 
  ApprovalText. (Text displayed when obtaining approval from the user).
  
• 
  InputPromptText. (Text displayed when obtaining input from the user).
  
• 
  SignaturePromptText. (Text displayed when obtaining a signature from the user).
  

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








string

int

string

string

string

string

int

string

string

string

string

string

string

string

string

string

string

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

int

string

string

string

string

int

string

string

string

string

string

string

string

string

string

string

string

string

string

string

HTTP/1.1 200 OK

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

Content-Length: length

Request Arguments

SetELinkDefaultsResultv2

SetELinkDefaultsResultv2 Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the SetELinkDefaults method was executed. If the SetELinkDefaults call was successful, the ErrorMessage is blank
Updated	Boolean	Indicates the default settings were updated.

SetELinkDefaults2

Syntax

SetELinkDefaultsResult = SetELinkDefaults2 (Token,ShareDays,FlagLog,FlagEmail,FlagMediaView,FlagPlayOptions,DownloadLimit,FlagViewOnly,FlagWatermark,WatermarkCenter,WatermarkBottom,FlagEmailFromSystem,EmailSubject,EmailBody,FlagReadReceipt,FlagCoverPage,CoverPageTitle,CoverPageMessage,ApprovalText,InputPromptText,SignaturePromptText,ShowName,ShowEmailAddress)

Usage

Use the SetELinkDefaults method to set the default settings for creating a FileShare link.

The following parameters are needed to make the SetELinkDefaults call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  ShareDays. (The number of days the FileReceive Link will remain active).
  
• 
  FlagLog. (Flag indicating logging of activity to FileReceive Link).
  
• 
  FlagEmail. (Flag indicating an email notification should be sent to recipients).
  
• 
  FlagMediaView. (Flag indicating the type of view for the FileShare).
  
• 
  FlagPlayOptions. (Flag indicating the play options for the FileShare).
  
• 
  DownloadLimit. (The maximum number of downloads for the FileShare).
  
• 
  FlagViewOnly. (Flag specifying if files can be downloaded or view-only).
  
• 
  FlagWatermark. (Flag indicating the FileShare has a watermark).
  
• 
  WatermarkCenter. (Text displayed in the center watermark).
  
• 
  WatermarkBottom. (Text displayed in the bottom watermark).
  
• 
  FlagEmailFromSystem. (Flag indicating the email notification should be sent from the system email account or the user’s email account).
  
• 
  EmailSubject. (Email notification subject).
  
• 
  EmailBody. (Email notification text).
  
• 
  FlagReadReceipt. (Flag indicating a read receipt should be generated when email notifications are read).
  
• 
  FlagCoverPage. (Flag indicating the FileShare has a cover page).
  
• 
  CoverPageTitle. (Title text for the cover page).
  
• 
  CoverPageMessage. (Message text for the cover page).
  
• 
  ApprovalText. (Text displayed when obtaining approval from the user).
  
• 
  InputPromptText. (Text displayed when obtaining input from the user).
  
• 
  SignaturePromptText. (Text displayed when obtaining a signature from the user).
  
• 
  ShowName. (Flag indicating to show the name of the owner of the fileshare).
  
• 
  ShowEmailAddress. (Flag indicating to show the email address of the owner of 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/SetELinkDefaults2"








string

int

string

string

string

string

int

string

string

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

int

string

string

string

string

int

string

string

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

Request Arguments

SetELinkDefaultsResultv2

SetELinkDefaultsResultv2 Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the SetELinkDefaults2 method was executed. If the SetELinkDefaults2 call was successful, the ErrorMessage is blank
Updated	Boolean	Indicates the default settings were updated.

SetFolderProperties

Syntax

SetFolderPropertiesResult = SetFolderProperties(Token,FolderPath,Comments,HasProperties,VC_FLAG_FILE_VERSION,VC_FLAG_FILE_CHECKOUT,VC_FLAG_FILE_DELETE,VC_FLAG_DAILY_EMAIL,VC_FLAG_UPDATE_EMAIL,VC_FLAG_OWNER_EMAIL,VC_FLAG_GROUPSHARE_EMAIL,VC_EMAIL_TO,RemoveChildProperties,VersionKeepCount,SaveFlag)

Usage

Use the SetFolderPropertiesResult method to set the properties for a folder.

The following parameters are needed to make the SetFolderProperties call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  FolderPath. (The path of the folder to set properties for).
  
• 
  Comments. (Comments to attach to the folder).
  
• 
  HasProperties. (Flag indicating the specified folder has properties).
  
• 
  VC_FLAG_FILE_VERSION. (Flag indicating the folder has version history control enabled).
  
• 
  VC_FLAG_FILE_CHECKOUT. (Flag indicating the folder has check-in/checkout enabled).
  
• 
  VC_FLAG_FILE_DELETE. (Flag indicating if delete is disabled for the folder).
  
• 
  VC_FLAG_DAILY_EMAIL. (Flag indicating if a daily email of activity is sent).
  
• 
  VC_FLAG_UPDATE_EMAIL. (Flag indicating if an email is sent when the folder properties are updated).
  
• 
  VC_FLAG_OWNER_EMAIL. (Flag indicating if emails are sent to the folder owner).
  
• 
  VC_FLAG_GROUPSHARE_EMAIL. (Flag indicating if emails are sent to members of the groupshare).
  
• 
  VC_EMAIL_TO. (Email addresses where emails are sent).
  
• 
  RemoveChildProperties. (Flag indicating the folder should remove properties from child folders).
  
• 
  VersionKeepCount. (Number of versions to keep when version control history is enabled).
  
• 
  SaveFlag. (Flag specifying save action).
  

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








string

string

string