Skip to main content

 Web service API

How to use PageSeeder's Web service API

list draft comments

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

com.pageseeder.comment.GetCommentDrafts

Description

This service returns the list of draft comments for the specified member.

Parameters

NameDescriptionRequiredTypeDefault value
pageThe page to loadnointeger1
pagesizeThe number of results per pagenointeger10
returngroupsThe groups to return in the output, can be none, user, or all (administrator only includes all comments)nostringnone

Permission

The member on the request or an administrator can invoke this service.

Response

The output has the following format:

<comments [limitreached="true"]>
  <comment id="234" 
           contentrole="File Attachment" 
           created="2012-03-08T12:34:00+10:00" 
           draft="true">
    <title>My thread</title>
    <content type="text/plain">Some text</content>
    <context  fragment="2">
      <uri|group id="789"> ... </uri|group>
    <context>
  </comment>
  ...
</comments>

Error Handling

No specific errors expected for this service.

Created on , last edited on