Api specifications

SOAP 1.2

POST /v2/fawapi.asmx HTTP/1.1

Host: api.filesanywhere.com

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

Content-Length: length








string

string

Small or Medium or Large

HTTP/1.1 200 OK

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

Content-Length: length

Sample Visual Basic.Net Code

Private Sub ItemCommentsWithThumbnail()

Dim FAWAPI As New WebReference.FAWAPI

Dim ItemCommentsResult As WebReference.ItemCommentsResult

ItemCommentsResult = FAWAPI. ItemCommentsWithThumbnail(

Token, ItemPath, ThumbnailSize)

If ItemCommentsResult.ErrorMessage <> "" Then

Msgbox ItemCommentsResult.ErrorMessage

End If

FAWAPI = Nothing

End Sub

Request Arguments

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.
Thumbnail	Base64Binary	The image stream of the profile image of the person who created the comment.

ListGroupShareUsers

Syntax

ListGroupShareUsersResult = ListGroupShareUsers(Token,SharedFolderName)

Usage

Use the ListGroupShareUsers method to list users who have access to a GroupShare.

The following parameters are needed to make the ListGroupShareUsers call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  SharedFolderName. (The path to the shared folder).
  

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








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

ListGroupShareUsersResult

ListGroupShareUsersResult Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the ListGroupShareUsers method was executed. If the ListGroupShareUsers call was successful, the ErrorMessage is blank.
GroupShareUsers.Username	String	The username of the user who has access to the GroupShare.
GroupShareUsers.Permission	String	The permission the user has been granted to the GroupShare.

ListItems2

This method lists all items in the specified path, including the user’s inbox and version history folders.

Syntax

ListItemsResult = ListItems2(Token, Path, PageSize, PageNum)

Usage

Use the ListItems2 method to get a list of all items in a folder.

The following parameters are needed to make the ListItems2 call:

• 
  Token (The Token ID returned by the last AccountLogin call).
  
• 
  Path (Full FilesAnywhere Path). This is the FilesAnywhere Path of the folder for which the item list is being requested. The Path should be formatted like \UserVolume\FolderName, where UserVolume is the FilesAnywhere UserName for which the item list is being requested and FolderName is the folder or subfolder if any for which the item list is being requested.
  
• 
  PageSize. (The maximum number of items to return).
  
• 
  PageNum. (The page number of results to return).
  

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








string

string

int

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

Content-Length: length










string





string

string

string

string

int

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

Sample Visual Basic.Net Code

Private Sub ListItems()

Dim FAWAPI As New WebReference.FAWAPI

Dim ListItemsResult As WebReference.ListItemsResult

ListItemsResult = FAWAPI.ListItems2(Token, Path, 20, 1)

If ListItemsResult.ErrorMessage <> "" Then

Msgbox ListItemsResult.ErrorMessage

End If

ListItemsResult = Nothing

End Sub

ListItemsResult

ListItemsResult Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the ListItems method was executed. If the ListItems call was successful, the ErrorMessage is blank
Items	Array of type Item	An array of Items
PageNum	Int	Current page Number for which items are returned.
PageCount	Int	Total number of pages for input PageSize.

An Item has the following properties:

Property Name	Data Type	Required	Description
Type	String	Yes	Type can either be a ‘file’ or a ‘folder’
Path	String	Yes	Full FilesAnywhere path of the Item in the form \UserVolume\FolderName\ItemName

ListLogActivities

Syntax

ListLogActivitiesResult = ListLogActivities(Token,StartDate,EndDate,FolderOrFile,ActivityType,SubType)

Usage

Use the ListLogActivities method to list activities to a file or folder.

The following parameters are needed to make the ListLogActivities call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  StartDate. (The date marking the beginning of the activity list returned).
  
• 
  EndDate. (The date marking the end of the activity list returned).
  
• 
  FolderOrFile. (The path to the folder or file to return activities for).
  
• 
  ActivityType. (Filter of activity types to return).
  
• 
  SubType. (Filter of activity sub types to return).