GetFolderProperties
Syntax
GetFolderPropertiesResult = GetFolderProperties(Token,FolderPath)
Usage
Use the GetFolderProperties method to retrieve the properties for a folder.
The following parameters are needed to make the GetFolderProperties call:
-
Token. (The Token ID returned by the last AccountLogin call).
-
FolderPath. (The path to the folder to retrieve properties for).
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/GetFolderProperties"
string
string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
string
string
dateTime
boolean
boolean
boolean
boolean
boolean
boolean
boolean
string
int
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
string
string
dateTime
boolean
boolean
boolean
boolean
boolean
boolean
boolean
string
int
Request Arguments
Name
|
Data Type
|
Required
|
Description
|
Token
|
String
|
Yes
|
The Token ID returned by the last AccountLogin call.
|
FolderPath
|
String
|
Yes
|
The path to the folder to retrieve properties for.
|
Response
GetFolderPropertiesResult
GetFolderPropertiesResult Properties
Name
|
Data Type
|
Description
|
ErrorMessage
|
String
|
A description of the error, if any error was encountered while the GetFolderProperties method was executed. If the GetFolderProperties call was successful, the ErrorMessage is blank
|
Comments
|
String
|
Comments attached to the folder.
|
FolderCreated
|
DateTime
|
The datetime stamp the folder was created.
|
VC_FLAG_FILE_VERSION
|
Boolean
|
Flag indicating if file version control history is enabled for the folder.
|
VC_FLAG_FILE_CHECKOUT
|
Boolean
|
Flag indicating if file check-in/checkout is enabled for the folder.
|
VC_FLAG_FILE_DELETE
|
Boolean
|
Flag indicating if disable delete is enabled for the folder.
|
VC_FLAG_DAILY_EMAIL
|
Boolean
|
Flag indicating if file activity for the folder is emailed daily.
|
VC_FLAG_UPDATE_EMAIL
|
Boolean
|
Flag indicating if updates to the folder are emailed.
|
VC_FLAG_OWNER_EMAIL
|
Boolean
|
Flag indicating to send emails to the owner.
|
VC_FLAG_GROUPSHARE_EMAIL
|
Boolean
|
Flag indicating to send emails to the members of the GroupShare.
|
VC_EMAIL_TO
|
String
|
Recipient addresses for email notifications.
|
VersionKeepCount
|
Integer
|
The number of versions to keep for version control history.
|
GetMeeting
Syntax
GetMeetingResult= GetMeeting(Token,Role,OrganizerOrAttendee,MeetingId)
Usage
Use the GetMeeting method to retrieve the properties of a scheduled meeting.
The following parameters are needed to make the GetMeeting call:
-
Token. (The Token ID returned by the last AccountLogin call).
-
Role. (The role of the OrganizerOrAttendee parameter).
-
OrganizerOrAttendee. (The user identifier for the meeting organizer, or attendee).
-
MeetingId. (The unique identifier for the meeting).
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/GetMeeting"
string
None or Organizer or Attendee or OrganizerOrAttendee
int
string
long
HTTP/1.1 200 OK
Content-Type: text/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
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
None or Organizer or Attendee or OrganizerOrAttendee
int
string
long
HTTP/1.1 200 OK
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
Request Arguments
Name
|
Data Type
|
Required
|
Description
|
Token
|
String
|
Yes
|
The Token ID returned by the last AccountLogin call.
|
Role
|
Enum
|
Yes
|
The role of the OrganizerOrAttendee parameter.
|
OrganizerOrAttendee
|
UserIdentifier
|
No
|
The user identifier for the meeting organizer or attendee. If null, then the current user is used.
|
MeetingId
|
Long
|
Yes
|
Unique identifier for the meeting.
|
Response
GetMeetingResult
GetMeetingResult Properties
Name
|
Data Type
|
Description
|
ErrorMessage
|
String
|
A description of the error, if any error was encountered while the GetMeeting method was executed. If the GetMeeting call was successful, the ErrorMessage is blank.
|
Meeting
|
Meeting
|
A populated meeting structure.
|
A Meeting has the following properties:
Property Name
|
Data Type
|
Required
|
Description
|
MeetingId
|
Long
|
Yes
|
Unique identifier for the meeting.
|
MeetingName
|
String
|
Yes
|
String identifier or title for the meeting.
|
Organizer
|
UserIdentifier
|
Yes
|
User identifier representing the organizer.
|
Role
|
Enum
|
Yes
|
The role of the current user in the meeting.
|
MeetingDate
|
DateTime
|
Yes
|
The scheduled start date of the meeting.
|
DurationInMinutes
|
Integer
|
Yes
|
The planned length of the meeting in minutes.
|
MeetingDescription
|
String
|
Yes
|
The agenda or discussion plans for the meeting.
|
SendReminder
|
Boolean
|
Yes
|
Flag indicating if reminder notifications are to be sent to attendees.
|
ReminderLeadTime
|
Enum
|
Yes
|
The number of minutes before the meeting starts to send reminder notifications.
|
Attendees
|
UserIdentifier()
|
Yes
|
Array of user identifiers representing attendees.
|
ReminderSent
|
Boolean
|
Yes
|
Flag indicating if reminder notifications have been sent.
|
GetNotifications
Syntax
GetNotificationsResult = GetNotifications(Token,DeviceId)
Usage
Use the GetNotifications method to retrieve non-APNS user notifications.
The following parameters are needed to make the GetNotifications call:
-
Token. (The Token ID returned by the last AccountLogin call).
-
DeviceId. (The physical device ID used in RegisterDevice).
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/GetNotifications"
string
string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
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
string
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
string
string
Request Arguments
Name
|
Data Type
|
Required
|
Description
|
Token
|
String
|
Yes
|
The Token ID returned by the last AccountLogin call.
|
DeviceId
|
String
|
Yes
|
The physical device ID used in RegisterDevice.
|
Response
GetNotificationsResult
GetNotificationsResult Properties
Name
|
Data Type
|
Description
|
ErrorMessage
|
String
|
A description of the error, if any error was encountered while the GetNotifications method was executed. If the GetNotifications call was successful, the ErrorMessage is blank
|
Data
|
XML
|
Notification data.
|
GetNotificationSettingForDevice
Syntax
GetNotificationSettingForDeviceResult = GetNotificationSettingForDevice(Token,DeviceId,NotificationType)
Usage
Use the GetNotificationSettingForDevice method to retrieve the setting for a specific notification type for a given device.
The following parameters are needed to make the GetNotificationSettingForDevice call:
-
Token. (The Token ID returned by the last AccountLogin call).
-
DeviceId. (The physical device ID used in RegisterDevice).
-
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/GetNotificationSettingForDevice"
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
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
string
boolean
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
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
string
boolean
Request Arguments
Name
|
Data Type
|
Required
|
Description
|
Token
|
String
|
Yes
|
The Token ID returned by the last AccountLogin call.
|
DeviceId
|
String
|
Yes
|
The physical device ID used in RegisterDevice.
|
NotificationType
|
Enum
|
Yes
|
The notification type to retrieve the setting for.
|
Response
GetNotificationSettingForDeviceResult
GetNotificationSettingForDeviceResult Properties
Name
|
Data Type
|
Description
|
ErrorMessage
|
String
|
A description of the error, if any error was encountered while the GetNotificationSettingForDevice method was executed. If the GetNotificationSettingForDevice call was successful, the ErrorMessage is blank
|
Allowed
|
Boolean
|
Whether the notification type is allowed or not.
|
GetNotificationSettingsForDevice
Syntax
GetNotificationSettingsForDeviceResult = GetNotificationSettingsForDevice(Token,DeviceId)
Usage
Use the GetNotificationSettingsForDevice method to retrieve the notification settings for a given device.
The following parameters are needed to make the GetNotificationSettingsForDevice call:
-
Token. (The Token ID returned by the last AccountLogin call).
-
DeviceId. (The physical device ID used in RegisterDevice).
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/GetNotificationSettingsForDevice"
string
string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
string
long
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
string
long
Request Arguments
Name
|
Data Type
|
Required
|
Description
|
Token
|
String
|
Yes
|
The Token ID returned by the last AccountLogin call.
|
DeviceId
|
String
|
Yes
|
The physical device ID used in RegisterDevice.
|
Response
GetNotificationSettingsForDeviceResult
GetNotificationSettingsForDeviceResult Properties
Name
|
Data Type
|
Description
|
ErrorMessage
|
String
|
A description of the error, if any error was encountered while the GetNotificationSettingsForDevice method was executed. If the GetNotificationSettingsForDevice call was successful, the ErrorMessage is blank
|
AllowedTypes.Value
|
Long
|
The numeric representation of the allowed notification types.
|
AllowedTypes.AllowedType.Type
|
Enum
|
The allowed notification type.
|
AllowedTypes.AllowedType.Value
|
Long
|
The numeric representation of the allowed notification type.
|
GroupShareAdd2
Syntax
GroupShareAdd2Result = GroupShareAdd2(Token,UserAccountsWithWhomToShareFolder,SharedFolderName,SharedFolderAccessLevel,NotifyByEmail,Notes)
Usage
Use the GroupShareAdd2 method to create a new GroupShare.
The following parameters are needed to make the GroupShareAdd2 call:
-
Token. (The Token ID returned by the last AccountLogin call).
-
UserAccountsWithWhomToShareFolder. (List of users to share with).
-
SharedFolderName. (The path to the folder to share).
-
SharedFolderAccessLevel. (The type of access to grant to the users).
-
NotifyByEmail. (Flag indicating to send an email notification to the users).
-
Notes. (Notes field for GroupShare).
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/GroupShareAdd2"
string
string
string
string
string
string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
string
string
string
boolean
string
string
boolean
boolean
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
string
string
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
string
string
string
boolean
string
string
boolean
boolean
Request Arguments
Name
|
Data Type
|
Required
|
Description
|
Token
|
String
|
Yes
|
The Token ID returned by the last AccountLogin call.
|
UserAccountsWithWhomToShareFolder
|
String
|
Yes
|
Semi-colon-separated list of usernames to share with.
|
SharedFolderName
|
String
|
Yes
|
The path to the folder to share.
|
SharedFolderAccessLevel
|
String
|
Yes
|
The permissions for the users to the GroupShare.
|
NotifyByEmail
|
String
|
Yes
|
Flag indicating to send email notification to users.
|
Notes
|
String
|
Yes
|
Notes field.
|
Response
GroupShareAdd2Result
GroupShareAdd2Result Properties
Name
|
Data Type
|
Description
|
ErrorMessage
|
String
|
A description of the error, if any error was encountered while the GroupShareAdd2 method was executed. If the GroupShareAdd2 call was successful, the ErrorMessage is blank.
|
Users.ErrorMessage
|
String
|
Error message pertaining to one user.
|
Users.Username
|
String
|
The username.
|
Users.UserAdded
|
Boolean
|
Flag indicating if the user was successfully added.
|
GroupShareCreated
|
Boolean
|
Flag indicating if the GroupShare was created.
|
GroupShareRemove
Syntax
GroupShareRemoveResult = GroupShareRemove(Token,SharedFolderName,UserAccountsToRemove,SendEmail)
Usage
Use the GroupShareRemove method to remove users from a GroupShare.
The following parameters are needed to make the GroupShareRemove call:
-
Token. (The Token ID returned by the last AccountLogin call).
-
SharedFolderName. (The path to the folder to share).
-
UserAccountsToRemove. (List of usernames to remove).
-
SendEmail. (Flag indicating to send email notification to users removed).
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/GroupShareRemove"
string
string
string
boolean
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
string
string
string
boolean
string
string
boolean
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
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
string
string
string
boolean
string
string
boolean
Request Arguments
Name
|
Data Type
|
Required
|
Description
|
Token
|
String
|
Yes
|
The Token ID returned by the last AccountLogin call.
|
SharedFolderName
|
String
|
Yes
|
The path to the shared folder.
|
UserAccountsToRemove
|
String
|
Yes
|
Semi-colon-separated list of usernames to remove from the GroupShare.
|
SendEmail
|
Boolean
|
Yes
|
Flag indicating to send an email notification to the user’s removed from the GroupShare.
|
Response
GroupShareRemoveResult
GroupShareRemoveResult Properties
Name
|
Data Type
|
Description
|
ErrorMessage
|
String
|
A description of the error, if any error was encountered while the GroupShareRemove method was executed. If the GroupShareRemove call was successful, the ErrorMessage is blank.
|
Users.ErrorMessage
|
String
|
Error message pertaining to one user.
|
Users.Username
|
String
|
The username.
|
Users.UserRemoved
|
Boolean
|
Flag indicating if the user was successfully removed.
|
ItemComments
Syntax
ItemCommentsResult = ItemComments(Token,ItemPath)
Usage
Use the ItemComments method to list comments for an item.
The following parameters are needed to make the ItemComments call:
-
Token. (The Token ID returned by the last AccountLogin call).
-
ItemPath. (The path to the file or folder).
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/ItemComments"
string
string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
string
long
string
string
dateTime
long
string
long
string
string
dateTime
long
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
string
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
string
long
string
string
dateTime
long
string
long
string
string
dateTime
long
string
Request Arguments
Name
|
Data Type
|
Required
|
Description
|
Token
|
String
|
Yes
|
The Token ID returned by the last AccountLogin call.
|
ItemPath
|
String
|
Yes
|
The path to the file or folder.
|
Response
ItemCommentsResult
ItemCommentsResult Properties
Name
|
Data Type
|
Description
|
ErrorMessage
|
String
|
A description of the error, if any error was encountered while the ItemComments method was executed. If the ItemComments call was successful, the ErrorMessage is blank.
|
CommentList.ID
|
Long
|
Comment ID.
|
CommentList.Comment
|
String
|
The comment.
|
CommentList.CreatedBy
|
String
|
The name of the person who created the comment.
|
CommentList.CreatedOn
|
DateTime
|
The datetime stamp the comment was created.
|
CommentList.ParentID
|
Long
|
The parent comment the comment applies to.
|
Username
|
String
|
The username of the person who created the comment.
|
ItemCommentsWithThumbnail
Syntax
ItemCommentsResult = ItemCommentsWithThumbnail(Token,ItemPath,ThumbnailSize)
Usage
Use the ItemCommentsWithThumbnail method to list comments, including the profile image of the commenter for an item.
The following parameters are needed to make the ItemCommentsWithThumbnail call:
-
Token. (The Token ID returned by the last AccountLogin call).
-
ItemPath. (The path to the file or folder).
-
ThumbnailSize. (The size of the image to be specified as Small or Medium or Large)
Share with your friends: | 
