Api specifications

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

boolean

boolean

boolean

boolean

boolean

boolean

boolean

boolean

string

boolean

int

DetachFromParent or InheritFromParent or SaveProperties

HTTP/1.1 200 OK

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

Content-Length: length

Request Arguments

SetFolderPropertiesResult

SetFolderPropertiesResult Properties

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

SetNotificationSettingForDevice

Syntax

SetNotificationSettingForDeviceResult = SetNotificationSettingForDevice(Token,DeviceId,NotificationType,Allow)

Usage

Use the SetNotificationSettingForDevice method to enable or disable a specific notification type on a given device.

The following parameters are needed to make the SetNotificationSettingForDevice call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  DeviceId. (The physical device Id).
  
• 
  NotificationType. (The type of notification to allow or disable).
  
• 
  Allow. (Flag indicating if the notification type is allowed or disabled).
  

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








string

string

NONE or 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

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

NONE or 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

boolean

HTTP/1.1 200 OK

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

Content-Length: length

Request Arguments

SetNotificationSettingsForDeviceResult

SetNotificationSettingsForDeviceResult Properties

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

SetNotificationSettingsForDevice

Syntax

SetNotificationSettingsForDeviceResult = SetNotificationSettingsForDevice(Token,DeviceId,AllowedNotificationTypes)

Usage

Use the SetNotificationSettingsForDevice method to indicate which notification types are enabled for a given device.

The following parameters are needed to make the SetNotificationSettingsForDevice call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  DeviceId. (The physical device Id).
  
• 
  AllowedNotificationTypes. (The numeric representation of the types of notification to allow).
  

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








string

string

long

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

long






HTTP/1.1 200 OK

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

Content-Length: length










string

Request Arguments

SetNotificationSettingsForDeviceResult

SetNotificationSettingsForDeviceResult Properties

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

StopSharingGroupShare

Syntax

StopSharingGroupShareResult = StopSharingGroupShare (Token,SharedFolderName,SendEmail)

Usage

Use the StopSharingGroupShare method to stop sharing a GroupShare.

The following parameters are needed to make the StopSharingGroupShare call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  SharedFolderName. (Path to the folder being shared).
  
• 
  SendEmail. (Flag indicating an email notification should be sent to GroupShare members).
  

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








string

string

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

boolean

HTTP/1.1 200 OK

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

Content-Length: length

Request Arguments

StopSharingGroupShareResult

StopSharingGroupShareResult Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the StopSharingGroupShare method was executed. If the StopSharingGroupShare call was successful, the ErrorMessage is blank
Users.ErrorMessage	String	Error message pertaining to the removal of a single user.
Users.Username	String	The username of a user removed from the GroupShare.
Users.UserRemoved	Boolean	Indicates if the user was removed from the GroupShare.
GroupShareRemoved	Boolean	Indicates if the GroupShare was removed.

UndoCheckout

Syntax

UndoCheckoutResult = UndoCheckout (Token,ItemPath,Comments)

Usage

Use the UndoCheckOut method to undo a file check-out.

The following parameters are needed to make the UndoCheckOut call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  ItemPath. (Path to the item that is checked-out).
  
• 
  Comments. (Comments text attached to the undo checkout 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/UndoCheckout"








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

UndoCheckoutResult

UndoCheckoutResult Properties

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

UnregisterDevice

Syntax

UnregisterDeviceResult = UnregisterDevice(Token,DeviceId,DeviceToken)

Usage

Use the UnregisterDevice method to remove a device registration for notifications.

The following parameters are needed to make the UnregisterDevice call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  DeviceId. (The physical device Id).
  
• 
  DeviceToken. (The logical device Id used in RegisterDevice).
  

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








string

string

string

HTTP/1.1 200 OK

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

Content-Length: length

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

UnregisterDeviceResult

UnregisterDeviceResult Properties

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

UpdateMeeting

Syntax

UpdateMeetingResult= UpdateMeeting(Token,Meeting)

Usage

Use the UpdateMeeting method to modify the properties of a scheduled meeting.

The following parameters are needed to make the UpdateMeeting call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  Meeting. (A populated meeting structure).
  

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








string



long

string



None or Organizer or Attendee or OrganizerOrAttendee

dateTime

string

boolean

None or FiveMinutes or FifteenMinutes or ThirtyMinutes or FortyFiveMinutes or OneHour









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



long

string



None or Organizer or Attendee or OrganizerOrAttendee

dateTime

string

boolean

None or FiveMinutes or FifteenMinutes or ThirtyMinutes or FortyFiveMinutes or OneHour









boolean

HTTP/1.1 200 OK

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

Content-Length: length

Request Arguments

UpdateMeetingResult Properties

Syntax

UploadFileWithCheckinResult = UploadFileWithCheckin(Token,Path,FileData,Comments)

Usage

Use the UploadFileWithCheckin method to upload a file and check the file in.

The following parameters are needed to make the UploadFileWithCheckin call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  Path. (The path to the file being uploaded).
  
• 
  FileData. (The file contents).
  
• 
  Comments. (Comments attached to the file check-in 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/UploadFileWithCheckin"








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

HTTP/1.1 200 OK

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

Content-Length: length

Request Arguments

UploadFileResult

UploadFileResult Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the UploadFileWithCheckin method was executed. If the UploadFileWithCheckin call was successful, the ErrorMessage is blank
Uploaded	Boolean	Indicates if the file was uploaded successfully.

UserLookup

Syntax

UserLookupResult = UserLookup(Token,SearchText,TeamId,SortBy,SortOrder,StartPage,PageSize,AutoComplete)

Usage

Use the UserLookup method to list or find users based on search criteria.

The following parameters are needed to make the UserLookup call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  SearchText. (The search pattern used to filter user results).
  
• 
  TeamId. (A team identifier to restrict the search to).
  
• 
  SortBy. (Sort criteria for results).
  
• 
  SortOrder. (Ascending or descending order of SortBy).
  
• 
  StartPage. (The current page within the paged results).
  
• 
  PageSize. (The number of entries per page in the paged results).
  
• 
  AutoComplete. (Flag indicating a shortened search should be used for purposes of rapid auto completion).
  

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








string

string

string

ID or IMAGEICON or USERNAME or FIRSTNAME or LASTNAME or EMAILADDRESS or COMPANYNAME

ASC or DESC

int

int

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

ID or IMAGEICON or USERNAME or FIRSTNAME or LASTNAME or EMAILADDRESS or COMPANYNAME

ASC or DESC

int

int

HTTP/1.1 200 OK

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

Content-Length: length

Sample VB.Net Code

Request Arguments

Name	Data Type	Required	Description
Token	String	Yes	The Token ID returned by the last AccountLogin call.
SearchText	String	Yes	The search pattern used to filter user results.
TeamId	String	Yes	A team identifier to restrict the search to.
SortBy	Enum	Yes	Sort criteria for results.
SortOrder	Enum	Yes	Ascending or descending order of SortBy.
StartPage	Integer	Yes	The current page within the paged results.
PageSize	Integer	Yes	The number of entries per page in the paged results.
AutoComplete	Boolean	Yes	Flag indicating a shortened search should be used for purposes of rapid auto completion.

Response

UserLookupResult

UserLookupResult Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the UserLookup method was executed. If the UserLookup call was successful, the ErrorMessage is blank
Items.ID	String	User identifier
Items.IMAGEICON	String	URL to icon image for the user.
Items.FIRSTNAME	String	First name of the user.
Items.LASTNAME	String	Last name of the user.
Items.EMAILADDRESS	String	Email address of the user.
ITEMS.COMPANYNAME	String	The company name for the user.
ITEMS.USERNAME	String	The username of the user.

GetProfileImage

This method returns the profile image for an user, when the login token and image size are passed as parameters. The image size returned back can have either of 3 sizes: small (24 x 24), medium (80 x 80), or large (225 x 300).

Syntax

ItemImageResult = GetProfileImage(Token, ProfileImageSize)

Usage

Use the GetProfileImage method to get the profile image of an user.

The following parameters are needed to make the GetProfileImage call:

• 
  Token (The Token ID returned by the last AccountLogin call).
  
• 
  ProfileImageSize is the size of the image to be specified as a string value which can be either “small”, “medium” or “large”.