Api specifications

SOAP 1.2

POST /fawapi.asmx HTTP/1.1

Host: 64.156.56.142

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

Sample Visual Basic.Net Code

Private Sub getItemDescription ()

Dim FAWAPI As New WebReference.FAWAPI

Dim ItemDescriptionResult As New WebReference.ItemDescriptionResult

ItemDescriptionResult= FAWAPI.ItemDescription(Token, Path)

If ItemDescriptionResult.ErrorMessage IsNot Nothing Then

Msgbox ItemDescriptionResult.ErrorMessage

Exit Sub

End If

Msgbox ItemDescriptionResult.Comment

End If

ItemDescriptionResult = Nothing

End Sub

ItemDescriptionResult

ItemDescriptionResult Properties

Name	Data Type	Description
ErrorMessage	String	A description of the error, if any error was encountered while the ItemComment method was executed. If the ItemDescription call was successful, the ErrorMessage is blank or null.
Comment	String	Comment of the item as string.

ItemDescriptionAdd

This method adds description of a file/folder.

Syntax

ItemDescriptionAddResult = ItemDescriptionAdd(Token,Path,Description)

Usage

Use the ItemDescriptionAdd method to add the description of an item.

The following parameters are needed to make the ItemDescriptionAdd call:

• 
  Token (The Token ID returned by the last AccountLogin call).
  
• 
  Path (Name of the item with the FilesAnywhere Path). The Path should be formatted like, for file: \UserVolume\FolderName\FileName and for folder: \UserVolume\FolderName\, where UserVolume is the FilesAnywhere UserName in whose account the file/folder exists.
  
• 
  Description (Description of a file/folder)