Web service API

How to use PageSeeder's Web service API

find comments

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

com.pageseeder.comment.GetCommentsByFilter

Description

Load a list of comments using filter parameters.

This service performs the same as Service: /comments/find [GET] but will return any comments that {member} has access to.

Parameters

NameDescriptionRequiredTypeDefault value
groupsA comma-separated list of group names the comments must belong toyesstrings
archivedif "true" include archived commentsnobooleanfalse
attachmentsThe attachments to include
(can be "none", "context" or "all")
noenumall
authorThe member id of the comments authornolong
contentsThe contents to include
(can be "none" or "all")
noenumall
contextThe context for the comments (can be "group", "uri", "all")noenumall
createdafterThe date time after which the comments were created e.g. 2010-10-25T12:26:00+10:00nodatetime
createdbeforeThe date time before which the comments were created e.g. 2011-08-25T10:20:00-04:00nodatetime
emailsThe emails to include
(can be "none" or "all"). Administrator use ONLY.
noenumnone
labelscomma-separated list of labelsnostring
moderatedif "true" include moderated (not accepted) commentsnobooleanfalse
pageThe page to loadnolong1
pagesizeThe number of results per pageno long1000
pathsThe context URI paths for the comments - must be URL encoded (comma-separated list with optional * suffix)nopaths
positionif "first" only search first comment in a discussion (may be faster when using paths)nostringany
returngroupsThe groups to return in the output (can be "none","specified")noenum"none" or if multiple groups "specified"
statusescomma-separated list of statusesnostring
titleThe title the comments must have (optional wild card * suffix, use ** to escape)nostring
typeThe type the comments must have (optional wild card * suffix, use ** to escape)nostring
typesThe types the comment can have (comma-separated list, empty string means no type)nostrings

Permission

The member in the request must have access to all the groups in the groups parameter. If the emails parameter is set to all, then the service is restricted to administrators only.

Response

The output has the following format:

<comments>
   <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>
      <context>
         <group id="3" name="acme-test" />
      </context>
   </comment>
   <comment id="567">
      ...
      <context fragment="2">
         <uri id="789">...</uri>
      </context>
   </comment>
</<comments>

Error Handling

CodeCause / Description
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