find comments
/members/{member}/comments/find [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.2102 | 6.0000 | xml, json |
Description
Load a list of comments using filter parameters. The most recent comments are returned first.
This service performs the same as Service: /comments/find [GET] but returns any comments that {member} has access to.
Parameters
| Name | Description | Required | Type | Default value |
|---|---|---|---|---|
| groups | A comma-separated list of group names the comments must belong to | yes | strings | |
| archived | If true, include archived comments | no | boolean | false |
| attachments | The attachments to include (can be none, context or all) | no | enum | all |
| author | The ID of the comments author | no | long | |
| contents | The contents to include (can be none or all) | no | enum | all |
| context | Only return comments in this context (can be group, uri, all) | no | enum | all |
| createdafter | The date time after which the comments were created e.g. 2010-10-25T12:26:00+10:00 | no | datetime | |
| createdbefore | The date time before which the comments were created e.g. 2011-08-25T10:20:00-04:00 | no | datetime | |
| emails | The emails to include (can be none or all). Administrator use ONLY | no | enum | none |
| labels | A comma-separated list of label values – comment MUST have all (not recommended for filtering large data sets) | no | string | |
| moderated | If true, include moderated (not accepted) comments | no | boolean | false |
| page | The page to load | no | long | 1 |
| pagesize | The number of results per page | no | long | 1000 |
| paths | The context URI paths for the comments – MUST be URL encoded (comma-separated list with optional * suffix) | no | paths | |
| position | If first, only the first (root) comment in a discussion is returned (might be faster when using paths) | no | string | any |
| returngroups | The groups to return in the output (can be none or specified) | no | enum | "none" or if multiple groups "specified" |
| statuses | Comma-separated list of statuses | no | string | |
| title | The title the comments MUST have (optional wildcard * suffix, use ** to escape) | no | string | |
| type | The type the comments MUST have (optional wildcard * suffix, use ** to escape) | no | string | |
| types | Comma-separated list of types the comment can have (empty string means no type) | no | strings |
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 administrator 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
| Code | Cause / Description |
|---|---|
| 0x1306 | The Group is invalid or not accessible |
| 0x1312 | The createdafter or createdbefore date is invalid |
| 0x1313 | The author is invalid |