Skip to main content

 Web service API

How to use PageSeeder's Web service API

list member discussions

/members/{member}/discussions [GET]

com.pageseeder.comment.GetDiscussions

Description

This class is not part of the public API, and might be subject to change!

Load a list of discussions from the current user's groups.

Parameters

NameDescriptionRequiredTypeDefault value
commentsThe comments to include, can be none, first, last, all, or archivenostringall
discussionsizeThe maximum number of comments to return per discussionnointeger100
pageThe page to loadnointeger1
pagesizeThe number of results per pagenointeger10
projectReturn only discussions from the current user's groups that are under this projectnostring
returngroupsThe groups to return in the output, can be none, user, or all (administrator only)nostringnone

Only administrators can specify all to return all the groups for a comment.

Permission

This service can only be invoked by the user matching the member ID or an administrator.

Response

This service returns a <discussions> element listing each discussion in a <discussion> element.

<discussions>
  <discussion id="288" 
              title="original" 
              replycount="2" 
              lastcommentid="290" 
              lastcommentdate="2017-02-21T15:33:07+11:00">
    <comment id="288" 
             contentrole="Comment" 
             created="2017-02-21T15:32:35+11:00">
      <title>original</title>
      <author id="1" 
              firstname="John" 
              surname="Smith"
              username="jsmith"
              status="activated">
        <fullname>John Smith</fullname>
      </author>
      <content type="text/plain">Original Document</content>
    </comment>
    <comment id="289" 
             contentrole="Comment"
             created="2017-02-21T15:32:59+11:00">
      <title>original</title>
      <author id="1" ...> ... </author>
      <content type="text/plain">First Reply</content>
    </comment>
    <comment id="290" 
             contentrole="Comment"
             created="2017-02-21T15:33:07+11:00">
      <title>original</title>
      <author id="1" ...> ... </author>
      <content type="text/plain">Second Reply</content>
    </comment>
    <comment id="292" 
             contentrole="Comment" 
             created="2017-02-22T09:21:48+11:00">
      <title>original</title>
      <author><fullname>Jane Brown</fullname></author>
      <content type="text/plain">TestComment</content>
    </comment>
  </discussion>
  <discussion ...>
  </discussion>
</discussions>

By default, all discussion comments are included.

The effect of the comments parameter on the response is described here.

Error Handling

No specific errors expected for this service.

Created on , last edited on