Api specifications

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 ListUserVolumes()

Dim FAWAPI As New WebReference.FAWAPI

Dim ListUserVolumesResult As WebReference.ListUserVolumesv2Result

ListUserVolumesResult = FAWAPI.ListUserVolumes2(Token)

If ListUserVolumesResult.ErrorMessage <> "" Then

Msgbox ListUserVolumesResult.ErrorMessage

End If

ListUserVolumesResult = Nothing

End Sub

ListUserVolumesResult

ListUserVolumesResult Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the ListUserVolumes method was executed. If the ListUserVolumes call was successful, the ErrorMessage is blank
UserVolumes	Array of type UserVolumev2	An array of UserVolumesv2

A UserVolumev2 has the following properties:

Property Name	Data Type	Required	Description
Username	String	Yes	This is the FilesAnywhere account Username
Permission	String	Yes	This can have the values ‘R’ for (Read only), ‘F’ for (Full Access) and ‘C’ for (Create and Update)
Path	String	Yes	The path to the volume shared to the user which can be used in ListItems and other methods.

MoveItems

Syntax

MoveItemsResult= MoveItems(Token,SrcPath,DstPath)

Usage

Use the MoveItems method to move one or more files and/or folders.

The following parameters are needed to make the MoveItems call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  SrcPath. (List of paths to files or folders to move).
  
• 
  DstPath. (The path to the folder to move the source paths 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/MoveItems"








string

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

string

HTTP/1.1 200 OK

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

Content-Length: length

Request Arguments

MoveItemsResultv2

MoveItemsResultv2 Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the MoveItems method was executed. If the MoveItems call was successful, the ErrorMessage is blank.
MovedItems.ErrorMessage	String	Error message pertaining to one specific file.
MovedItems.SrcPath	String	The path of the source file or folder.
MovedItems.DstPath	String	The path of the destination file or folder.
Items.Moved	Boolean	Flag indicating the item was moved successfully.

RegisterDevice

Syntax

RegisterDeviceResult= RegisterDevice(Token,DeviceId,DeviceToken)

Usage

Use the RegisterDevice method to register a device for notifications.

The following parameters are needed to make the RegisterDevice call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  DeviceId. (Physical ID of the device).
  
• 
  DeviceToken. (Logical ID for the device or session).
  

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








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

RegisterDeviceResult Properties