Web service API

How to use PageSeeder's Web service API

find discussions

/members/{member}/discussions/find [GET]

com.pageseeder.comment.GetDiscussionsByFilter

Description

Find discussions

Warning!

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

Load a list of discussions using filter parameters. A comment in the discussion must match all filter parameters.

The output has the following format:


 <discussions>
   <discussion id="123" title="My thread"
               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>
     </comment>
   </discussion>
   <discussion id="100">
     ...
   </discussion>
 </discussions>

Parameters

Name Description Required Type Default value
attachments the attachments to include, can be "none", "context", "all" no enum all
author the member id of the comment author no long
comments the replies to include, can be "none","first","last","all","archive" no enum last
contents the contents to include, can be "none", "all" no enum all
context the context for the comments, can be "group", "uri", "all" no enum all
createdafter the date time after which the comments were created format is ISO-8601 e.g. 2010-10-25T12:26:00+10:00 no datetime
createdbefore the date time before which the comments were created format is ISO-8601 e.g. 2011-08-25T10:20:00-04:00 no datetime
discussionsize the maximum number of comments to return per discussion no integer 100
emails the email addresses to include, can be "none", "all" (admin only) no enum none
groups the groups the comments must belong to (comma-separated list of names, if not specified, the user's current groups are used) no strings
labels comma-separated list of labels - comment must have all (not recommended for filtering large data sets) no strings
page the page to load no integer 1
pagesize the number of results per page no integer 1000
paths the context URI paths for the comments - must be URL encoded (comma-separated list with optional * suffix) no strings
project return only discussions from the current user's groups that are under this project (only if groups not specified) no string
title the title of the comments (optional wild card * suffix, use ** to escape) no string
type the type of the comments (optional wild card * suffix, use ** to escape) no string
types the types the comment can have (comma-separated list, empty string means no type) no strings

Permission

Undocumented permissions requirements.

Response

Undocumented XML response

The output has the following format:


 <discussions>
   <discussion id="123" title="My thread"
               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>
     </comment>
   </discussion>
   <discussion id="100">
     ...
   </discussion>
 </discussions>

Error Handling

0x1303 Context 'group' cannot be used with 'paths' parameter
0x1306 The Group is invalid or not accessible
0x1312 The createdafter or createdbefore date is invalid
0x1313 The author is invalid

Created on , last edited on