Skip to main content

 Web service API

How to use PageSeeder's Web service API

list member group discussions

/members/{member}/groups/{group}/discussions [GET]

com.pageseeder.comment.GetDiscussionsForGroup

Description

Load a list of discussions from the current group.

Parameters

NameDescriptionRequiredTypeDefault value
archived
Whether to include discussions/attachedtos where all comments are archived (true if comments=archive). Requires PageSeeder 5.9907 or higher.noboolean
false
commentsThe comments to include, can be none,first,last,all,archivenostringall
discussionsizeThe maximum number of comments to return per discussionnointeger100
pageThe page to loadnointeger1
pagesizeThe number of results per pagenointeger10
returngroupsThe groups to return in the output, can be none,user,all(administrator only includes all comments)nostringnone

Permission

This service is restricted to guest and higher.

Response

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

<discussions>
  <discussion id="123"
              title="My thread"
              replycount="3"
              lastcommentid="234"
              lastcommentdate="2012-08-20T14:27:48+10:00">
    <uri id="789">...</uri>
    <locator fragment="2"/>
    <comment id="234"
             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>
     [<group id="12" name="acme-specs" />
      ...]
    </comment>
  </discussion>
  <discussion id="100">
  ...
  </discussion>
</discussions>

Error Handling

No specific errors expected for this service.

Created on , last edited on