Skip to main content

 Web service API

How to use PageSeeder's Web service API

find discussions public

/discussions/find [GET]

com.pageseeder.comment.GetDiscussionsByFilter

Description

Find public discussions.

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

Parameters

NameDescriptionRequiredTypeDefault value
attachmentsThe attachments to include, can be none, context, allnoenumall
authorThe ID of the comment authornolong
commentsThe replies to include, can be none, first, last, all, archivenoenumlast
contentsThe contents to include, can be none, allnoenumall
contextOnly return comments in this context, can be group, uri, all.noenumall
createdafterThe date time after which the comments were created, format is ISO-8601 e.g. 2010-10-25T12:26:00+10:00nodatetime
createdbeforeThe date time before which the comments were created, format is ISO-8601 e.g. 2011-08-25T10:20:00-04:00nodatetime
discussionsizeThe maximum number of comments to return per discussionnointeger100
emailsThe email addresses to include, can be none, all (admin only)noenumnone
groupsA comma-separated list of group names the comment should belong to (if not specified, the user’s current groups are used)nostrings
labelsComma-separated list of label values – comment MUST have all (not recommended for filtering large data sets)nostrings
pageThe page to loadnointeger1
pagesizeThe number of results per pagenointeger1000
pathsThe context URI paths for the comments – MUST be URL encoded (comma-separated list with optional * suffix)nostrings
titleThe title of the comments (optional wildcard * suffix, use ** to escape)nostring
typeThe type of the comments (optional wildcard * suffix, use ** to escape)nostring
typesComma-separated list of types the comment can have (empty string means no type)nostrings

Permission

If the parameter emails is set to all, the permission is restricted to administrator only. Otherwise, the permission is public.

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