Api specifications

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








string

FILEACTION_ANNOTATE or FILEACTION_DELETED or FILEACTION_EDIT or FILEACTION_MOVED or FILEACTION_RENAMED or FILEACTION_UPDATED or FILEACTION_UPLOAD or CHECKACTION_CHECKIN or CHECKACTION_CHECKOUT or FAXACTION_FAXRECEIVED or PRODUCTACTION_APPUPDATE or PRODUCTACTION_APPRATINGREMINDER or LIFECYCLEACTION_EXPIRATION or TESTINGACTION_ECHO or ESENDACTION_FILERECEIVED or EMAILACTION_FILERECEIVED or GROUPSHAREACTION_CREATED or GROUPSHAREACTION_PERMISSIONSCHANGE or GROUPSHAREACTION_REMOVED or DROPBOXACTION_FILEUPLOAD or DROPBOXACTION_LINKACCESS or FILESHAREACTION_FILEDOWNLOAD or FILESHAREACTION_LINKACCESS or ACCOUNTACTION_CREDITCARDDECLINED or ACCOUNTACTION_CREDITCARDEXPIRED or ACCOUNTACTION_PASSWORDCHANGE or ACCOUNTACTION_SIXTYDAYSWITHOUTLOGIN or ACCOUNTACTION_STORAGEEXCEEDED or NONE

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

FILEACTION_ANNOTATE or FILEACTION_DELETED or FILEACTION_EDIT or FILEACTION_MOVED or FILEACTION_RENAMED or FILEACTION_UPDATED or FILEACTION_UPLOAD or CHECKACTION_CHECKIN or CHECKACTION_CHECKOUT or FAXACTION_FAXRECEIVED or PRODUCTACTION_APPUPDATE or PRODUCTACTION_APPRATINGREMINDER or LIFECYCLEACTION_EXPIRATION or TESTINGACTION_ECHO or ESENDACTION_FILERECEIVED or EMAILACTION_FILERECEIVED or GROUPSHAREACTION_CREATED or GROUPSHAREACTION_PERMISSIONSCHANGE or GROUPSHAREACTION_REMOVED or DROPBOXACTION_FILEUPLOAD or DROPBOXACTION_LINKACCESS or FILESHAREACTION_FILEDOWNLOAD or FILESHAREACTION_LINKACCESS or ACCOUNTACTION_CREDITCARDDECLINED or ACCOUNTACTION_CREDITCARDEXPIRED or ACCOUNTACTION_PASSWORDCHANGE or ACCOUNTACTION_SIXTYDAYSWITHOUTLOGIN or ACCOUNTACTION_STORAGEEXCEEDED or NONE

string

HTTP/1.1 200 OK

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

Content-Length: length

Request Arguments

SetAPNSettingResult

SetAPNSettingResult 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
NotificationType	Enum	The notification type.
Setting	String	Flag indicating the notification type is enabled or disabled.

SetAPNSettings

Syntax

SetAPNSettingsResult = SetAPNSettings(Token,Settings)

Usage

Use the SetAPNSettings 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).
  
• 
  Settings List of Setting type consisting of NotificationType and Setting
  

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








string



FILEACTION_ANNOTATE or FILEACTION_DELETED or FILEACTION_EDIT or FILEACTION_MOVED or FILEACTION_RENAMED or FILEACTION_UPDATED or FILEACTION_UPLOAD or CHECKACTION_CHECKIN or CHECKACTION_CHECKOUT or FAXACTION_FAXRECEIVED or PRODUCTACTION_APPUPDATE or PRODUCTACTION_APPRATINGREMINDER or LIFECYCLEACTION_EXPIRATION or TESTINGACTION_ECHO or ESENDACTION_FILERECEIVED or EMAILACTION_FILERECEIVED or GROUPSHAREACTION_CREATED or GROUPSHAREACTION_PERMISSIONSCHANGE or GROUPSHAREACTION_REMOVED or DROPBOXACTION_FILEUPLOAD or DROPBOXACTION_LINKACCESS or FILESHAREACTION_FILEDOWNLOAD or FILESHAREACTION_LINKACCESS or ACCOUNTACTION_CREDITCARDDECLINED or ACCOUNTACTION_CREDITCARDEXPIRED or ACCOUNTACTION_PASSWORDCHANGE or ACCOUNTACTION_SIXTYDAYSWITHOUTLOGIN or ACCOUNTACTION_STORAGEEXCEEDED or NONE

string





FILEACTION_ANNOTATE or FILEACTION_DELETED or FILEACTION_EDIT or FILEACTION_MOVED or FILEACTION_RENAMED or FILEACTION_UPDATED or FILEACTION_UPLOAD or CHECKACTION_CHECKIN or CHECKACTION_CHECKOUT or FAXACTION_FAXRECEIVED or PRODUCTACTION_APPUPDATE or PRODUCTACTION_APPRATINGREMINDER or LIFECYCLEACTION_EXPIRATION or TESTINGACTION_ECHO or ESENDACTION_FILERECEIVED or EMAILACTION_FILERECEIVED or GROUPSHAREACTION_CREATED or GROUPSHAREACTION_PERMISSIONSCHANGE or GROUPSHAREACTION_REMOVED or DROPBOXACTION_FILEUPLOAD or DROPBOXACTION_LINKACCESS or FILESHAREACTION_FILEDOWNLOAD or FILESHAREACTION_LINKACCESS or ACCOUNTACTION_CREDITCARDDECLINED or ACCOUNTACTION_CREDITCARDEXPIRED or ACCOUNTACTION_PASSWORDCHANGE or ACCOUNTACTION_SIXTYDAYSWITHOUTLOGIN or ACCOUNTACTION_STORAGEEXCEEDED or NONE

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



FILEACTION_ANNOTATE or FILEACTION_DELETED or FILEACTION_EDIT or FILEACTION_MOVED or FILEACTION_RENAMED or FILEACTION_UPDATED or FILEACTION_UPLOAD or CHECKACTION_CHECKIN or CHECKACTION_CHECKOUT or FAXACTION_FAXRECEIVED or PRODUCTACTION_APPUPDATE or PRODUCTACTION_APPRATINGREMINDER or LIFECYCLEACTION_EXPIRATION or TESTINGACTION_ECHO or ESENDACTION_FILERECEIVED or EMAILACTION_FILERECEIVED or GROUPSHAREACTION_CREATED or GROUPSHAREACTION_PERMISSIONSCHANGE or GROUPSHAREACTION_REMOVED or DROPBOXACTION_FILEUPLOAD or DROPBOXACTION_LINKACCESS or FILESHAREACTION_FILEDOWNLOAD or FILESHAREACTION_LINKACCESS or ACCOUNTACTION_CREDITCARDDECLINED or ACCOUNTACTION_CREDITCARDEXPIRED or ACCOUNTACTION_PASSWORDCHANGE or ACCOUNTACTION_SIXTYDAYSWITHOUTLOGIN or ACCOUNTACTION_STORAGEEXCEEDED or NONE

string





FILEACTION_ANNOTATE or FILEACTION_DELETED or FILEACTION_EDIT or FILEACTION_MOVED or FILEACTION_RENAMED or FILEACTION_UPDATED or FILEACTION_UPLOAD or CHECKACTION_CHECKIN or CHECKACTION_CHECKOUT or FAXACTION_FAXRECEIVED or PRODUCTACTION_APPUPDATE or PRODUCTACTION_APPRATINGREMINDER or LIFECYCLEACTION_EXPIRATION or TESTINGACTION_ECHO or ESENDACTION_FILERECEIVED or EMAILACTION_FILERECEIVED or GROUPSHAREACTION_CREATED or GROUPSHAREACTION_PERMISSIONSCHANGE or GROUPSHAREACTION_REMOVED or DROPBOXACTION_FILEUPLOAD or DROPBOXACTION_LINKACCESS or FILESHAREACTION_FILEDOWNLOAD or FILESHAREACTION_LINKACCESS or ACCOUNTACTION_CREDITCARDDECLINED or ACCOUNTACTION_CREDITCARDEXPIRED or ACCOUNTACTION_PASSWORDCHANGE or ACCOUNTACTION_SIXTYDAYSWITHOUTLOGIN or ACCOUNTACTION_STORAGEEXCEEDED or NONE

string

HTTP/1.1 200 OK

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

Content-Length: length

Request Arguments

SetAPNSettingsResult

SetAPNSettingsResult 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
Settings.APNSetting.NotificationType	Enum	The notification type.
Settings.APNSetting.Setting	String	Flag indicating the notification type is enabled or disabled.

SetDropBoxDefaults

Syntax

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

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).
  

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








string

int

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