GET:pages/{pageid}/comments

Overview

public. Retrieve the comments on a page

Message Format

Output:

<comments count="{int}" href="{uri}">
    <comment id="{int}" href="{uri}">
        <page.parent id="{uri}" href="{uri}">
            <title>{text}</title> 
            <path>{text}</path> 
        </page.parent>
        <user.createdby id="{int}" href="{uri}">
            <nick>{text}</nick> 
            <username>{text}</username> 
            <email>{text}</email> 
        </user.createdby>
        <date.posted>{date}</date.posted> 
        <title>{text}</title> 
        <number>{int}</number> 
        <content type="{mimetype}" href="{uri}">{text}</content> 
        <user.editedby id="{int}" href="{uri}">
            <nick>{text}</nick> 
            <username>{text}</username> 
            <email>{text}</email> 
        </user.editedby>
        <date.edited>{date}</date.edited> 
        <user.deletedby id="{int}" href="{uri}">
            <nick>{text}</nick> 
            <username>{text}</username> 
            <email>{text}</email> 
        </user.deletedby>
        <date.deleted>{date}</date.deleted> 
    </comment>
    ...
</comments>

Implementation Notes

The user.deletedby and date.deleted elements only exist if the comment has been deleted.

Use POST:pages/{pageid}/comments to add new comments to the page.

Code Samples

The following code example retrieves comments on the home page:

Plug p = Plug.New("http://deki-hayes/@api/deki");
p.At("users", "authenticate").WithCredentials("admin", "password").Get();
p.At("pages", "home", "comments").Get();

Sample response indicating that the home page has one comment:

<comments count="1" href="http://deki-hayes/@api/deki/pages/29/comments">
    <comment id="1" href="http://deki-hayes/@api/deki/pages/29/comments/1">
        <page.parent id="29" href="http://deki-hayes/@api/deki/pages/29">
            <title>DekiWiki (Hayes)</title> 
            <path /> 
        </page.parent>
        <user.createdby id="1" href="http://deki-hayes/@api/deki/users/1">
            <nick>Admin</nick> 
            <username>Admin</username> 
            <email>admin@mindtouch.com</email> 
        </user.createdby>
        <date.posted>2007-08-23T09:52:07Z</date.posted> 
        <title /> 
        <number>1</number> 
        <content type="text/plain" href="http://deki-hayes/@api/deki/pages/29/comments/1/content">Comment text</content> 
    </comment>
</comments>