Web service API

How to use PageSeeder's Web service API

comment

/members/{member}/comments/{commentid} [GET]

com.pageseeder.comment.GetComment

Description

Load a single comment from accessible groups.

Parameters

NameDescriptionRequiredTypeDefault value
emails the email addresses to include, can be "none", "all"(managers only) no string none
returngroups the groups to return in the output, can be "none", "user", "all"(admin only) no string none

Permission

Undocumented permissions requirements.

Response

The output has the following format:

<comment id="123"
         discussionid="456"
         contentrole="File Attachment"
         created="2012-03-08T12:34:00+10:00">
   <title>My thread</title>
   <content type="text/plain">Some text</content>
   <attachment>
      <uri id="189">...</uri>
   </attachment>
   <attachment fragment="5">
      <uri id="289">...</uri>
   </attachment>
   <context fragment="2">
      <uri|group id="789">...</uri|group>
   <context>
   [<group .../>...]
</comment>

Error handling

CodeCause / Description
0x1317 the comment was not found

Created on , last edited on