Tuyu Developers

Developers

Customize the URLs on this site with your Tuyu URL:

https:// .
Method Documentation > Files and Folders

File Comment List GET

Description

Retrieve all comments from a specific file or folder.

URL

All responses are in JSON format by default, to specify an XML response add “.xml” to the end of the method name (in this case “file_comment_list”)

https://<your subdomain>.<your domain>/api/file_comment_list

Restrictions

The calling user must have:

  • Access to the location the requested file resides in.

Parameters

Bold indicates required. Please note parameters must be appended to the URL in alphabetical order, except for “signature”, which is always at the end.

Parameter Description
api_key Your API Key.
file_id ID of the file or folder whose comments are being retrieved.
timestamp The current time in Unix timestamp format.
signature Please see “User Authentication” for more information.

Sample Response

Successful response In JSON:

{"fileCommentList":[
    {"username":"jsmith","date":1371825453,"comment":"Please review.","id":103},
    {"username":"jsmith","date":1371826544,"comment":"I reviewed but not sure about section 2.","id":104},
]}

Successful response in XML:

<fileCommentList>
    <commentItem>
        <username>jsmith</username>
        <date>1371825453</date>
        <comment>Please review.</comment>
        <id>103</id>
        </commentItem>
        <commentItem>
        <username>jsmith</username>
        <date>1371826544</date>
        <comment>I reviewed but not sure about section 2.</comment>
        <id>104</id>
    </commentItem>
</fileCommentList>

Error response In JSON:

{"error":{
    "title":"Authentication Failed",
    "message":"Authentication parameters missing or invalid."}
}

Error response In XML:

<error>
    <title>Authentication Failed</title>
    <message>Authentication parameters missing or invalid.</message>
</error>