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 /fawapi.asmx HTTP/1.1
Host: 64.156.56.142
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.filesanywhere.com/ItemCommentsList"
string
string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
string
xmlxml
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 /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
string
xmlxml
Sample Visual Basic.Net Code
Private Sub ItemCommentsList()
Dim FAWAPI As New WebReference.FAWAPI
Dim ItemCommentsListResult As New WebReference.ItemCommentsListResult
ItemCommentsListResult= FAWAPI.ItemCommentsList(Token,ItemPath)
If ItemCommentsListResult.ErrorMessage IsNot Nothing Then
Msgbox ItemCommentsListResult.ErrorMessage
Exit Sub
End If
If ItemCommentsListResult.CommentList IsNot Nothing Then
Dim dtTemp As New System.Data.DataTable()
dtTemp = ItemCommentsListResult.CommentList
End If
ItemCommentsListResult = Nothing
FAWAPI = Nothing
End Sub
Request Arguments
Name
|
Data Type
|
Required
|
Description
|
Token
|
String
|
Yes
|
The Token ID returned back in the last AccountLogin call
|
ItemPath
|
String
|
Yes
|
Full FilesAnywhere path of the file/folder in the form \UserVolume\FolderName\FileName or \UserVolume\FolderName\
|
Response
ItemCommentsListResultItemCommentsListResult Properties
Name
|
Data Type
|
Description
|
ErrorMessage
|
String
|
A description of the error, if any error was encountered while the ItemCommentsList method was executed. If the ItemCommentsList call was successful, the ErrorMessage is blank or null.
|
CommentList
|
Return the XML string.
|
List of comments whose structure is shown as below.
|
A CommentList has the following properties:
Property Name
|
Data Type
|
Description
|
ID
|
Int
|
Id of Comment
|
Comment
|
String
|
Comment added by user
|
CreatedBy
|
String
|
User name who has created this comment
|
CreatedOn
|
DateTime
|
Date on which comment created
|
ParentId
|
Int
|
Value in the parent id represent comment id of existing comment (reply of an existing comment) else it will be 0 means it is comment of a document
|
ItemDescription
This method returns comment of input file/folder.
Syntax
ItemImageResult = ItemDescription(Token,Path)
Usage
Use the ItemDescription method to get the description of item.
The following parameters are needed to make the ItemDescription 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 \UserVolume\FolderName\ItemName, where UserVolume is the FilesAnywhere UserName in whose account the item exists.
Share with your friends: |