Response DownloadWithCheckoutResult DownloadWithCheckoutResult Properties

DownloadWithCheckoutResult

DownloadWithCheckoutResult Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the DownloadWithCheckout method was executed. If the DownloadWithCheckout call was successful, the ErrorMessage is blank
URL	String	The URL from which the file can be downloaded.

DownloadZipFile

Syntax

DownloadZipFileResult = DownloadZipFile(Token,Path)

Usage

Use the DownloadZipFile method to download a zip file for a file or a folder.

The following parameters are needed to make the DownloadZipFile call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  Path. (The path of the file/folder to be downloaded).
  

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








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

DownloadZipFileResult

DownloadZipFileResult Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the DownloadZipFile method was executed. If the DownloadZipFile call was successful, the ErrorMessage is blank
DownloadFileStatus	Enum	The status for the download requrest.
ProcessId	Long	Process identifier used when DownloadFileStatus = Processing.

Sample Visual Basic.Net Code

Private Sub btnDownload_Click(sender As Object, e As EventArgs)

txtError.Text = String.Empty

Dim objFAWAPI As FAWAPI.FAWAPIv2SoapClient = New FAWAPI.FAWAPIv2SoapClient()

Dim objDownload As FAWAPI.DownloadFileResultv2 = Nothing

Do

objDownload = objFAWAPI.DownloadZipFile(txtToken.Text, "\USERNAME\FOLDERPATH\")

Loop While (objDownload.DownloadFileStatus = FAWAPI.DownloadFileStatus.Processing)

txtError.Text = objDownload.ErrorMessage

Return

End If

End Sub

EditDocumentWithZoho

Syntax

EditDocumentWithZohoResult = EditDocumentWithZoho(Token,Path)

Usage

Use the DownloadZipFile method to download one a file as a zip file.

The following parameters are needed to make the EditDocumentWithZoho call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  Path. (The path of the document to be edited).
  

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








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

EditDocumentWithZohoResult

EditDocumentWithZohoResult Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the EditDocumentWithZoho method was executed. If the EditDocumentWithZoho call was successful, the ErrorMessage is blank
URL	String	A URL which can be opened in a browser to edit the document.

ESendFiles

Syntax

ESendFilesResult = ESendFiles(Token,FileList,Recipients,Message)

Usage

Use the ESendFiles method to send files directly to another user’s file inbox.

The following parameters are needed to make the ESendFiles call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  
• 
  FileList. (The paths of the files to be sent to the recipients).
  
• 
  Recipients (A list of usernames to receive the files).
  
• 
  Message (A message to send with the notifications to the recipients).
  

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








string

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

string

HTTP/1.1 200 OK

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

Content-Length: length

Request Arguments

ESendFilesResult

ESendFilesResult Properties

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

GetAccountDetails

Syntax

GetAccountDetailsResult = GetAccountDetails(Token)

Usage

Use the GetAccountDetails method to retrieve a user’s account properties, including email address, storage allocation, storage usage, user account type, and account status.

The following parameters are needed to make the DownloadZipFile call:

• 
  Token. (The Token ID returned by the last AccountLogin call).
  

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








string






HTTP/1.1 200 OK

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

Content-Length: length










string

string

boolean

long

string

long

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

Request Arguments

GetAccountDetailsResult

GetAccountDetailsResult Properties

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