GetAPNSetting
Syntax
GetAPNSettingResult = GetAPNSetting (Token, NotificationType)
Usage
Use the GetAPNSetting method to determine if a specific notification type is permitted by the logged on user.
The following parameters are needed to make the GetAPNSetting call:
-
Token. (The Token ID returned by the last AccountLogin call).
-
NotificationType. (The type of notification.)
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/GetAPNSetting"
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
HTTP/1.1 200 OK
Content-Type: text/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
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
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
Response xmlns="http://api.filesanywhere.com/">
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
Request Arguments
Name
|
Data Type
|
Required
|
Description
|
Token
|
String
|
Yes
|
The Token ID returned by the last AccountLogin call.
|
NotificationType
|
Enum
|
Yes
|
The type of notification to receive the enabled setting for.
|
Response
GetAPNSettingResult
GetAPNSettingResult Properties
Name
|
Data Type
|
Description
|
ErrorMessage
|
String
|
A description of the error, if any error was encountered while the GetAPNSetting method was executed. If the GetAPNSetting call was successful, the ErrorMessage is blank
|
Settings.APNSetting
|
Enum
|
The notification type.
|
Settings.Setting
|
String
|
Flag indicating the notification type is enabled or disabled.
|
GetAPNSettings
Syntax
GetAPNSettingsResult = GetAPNSettings (Token)
Usage
Use the GetAPNSettings 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 GetAPNSettings call:
-
Token. (The Token ID returned by the last AccountLogin call).
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/GetAPNSettings"
string
HTTP/1.1 200 OK
Content-Type: text/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
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
HTTP/1.1 200 OK
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
Request Arguments
Name
|
Data Type
|
Required
|
Description
|
Token
|
String
|
Yes
|
The Token ID returned by the last AccountLogin call.
|
Response
GetAPNSettingsResult
GetAPNSettingsResult Properties
Name
|
Data Type
|
Description
|
ErrorMessage
|
String
|
A description of the error, if any error was encountered while the GetAPNSettings method was executed. If the GetAPNSettings 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.
|
GetDropBoxDefaults2
Syntax
GetDropBoxDefaults2Result = GetDropBoxDefaults2(Token)
Usage
Use the GetDropBoxDefaults2 method to retrieve the default settings for creating a new FileReceive Link.
The following parameters are needed to make the GetDropBoxDefaults2 call:
-
Token. (The Token ID returned by the last AccountLogin call).
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/GetDropBoxDefaults2"
string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
string
int
string
string
string
string
string
string
string
string
string
string
string
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
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
string
int
string
string
string
string
string
string
string
string
string
string
string
Request Arguments
Name
|
Data Type
|
Required
|
Description
|
Token
|
String
|
Yes
|
The Token ID returned by the last AccountLogin call.
|
Response
GetDropBoxDefaultsResult2v2
GetDropBoxDefaultsResult2v2 Properties
Name
|
Data Type
|
Description
|
ErrorMessage
|
String
|
A description of the error, if any error was encountered while the GetDropBoxDefaults2 method was executed. If the GetDropBoxDefaults2 call was successful, the ErrorMessage is blank
|
ShareDays
|
Integer
|
The number of days the link will be active.
|
FlagLog
|
String
|
Flag indicating to log access to the link.
|
FlagEmail
|
String
|
Flag indicating to send an email notification of the link to the recipients.
|
FlagEmailFromSystem
|
String
|
Flag indicating to use the system email address or the user’s email address.
|
EmailSubject
|
String
|
Subject of the email notification.
|
FlagAttachment
|
String
|
|
FlagReadReceipt
|
String
|
Flag indicating to send a read-receipt when the notification is read.
|
FlagOverwrite
|
String
|
Flag indicating to allow file overwrites.
|
SubFolderNamePrompt
|
String
|
Prompt used to create a separate partition within the FileReceive Link.
|
ReturnLinkLabel
|
String
|
Text displayed to return the user to a different URL.
|
ReturnLinkURL
|
String
|
The URL to return the user to.
|
GetELinkDefaults2
Syntax
GetELinkDefaults2Result = GetELinkDefaults2(Token)
Usage
Use the GetELinkDefaults2 method to retrieve the default settings for creating a new FileShare link.
The following parameters are needed to make the GetELinkDefaults2 call:
-
Token. (The Token ID returned by the last AccountLogin call).
Share with your friends: | 
