get discussion
/members/{member}/discussions/{discussion} [GET]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.1102 | 5.9500 | xml, json |
Description
Loads a discussion. If a reply comment ID is specified for the discussion, it returns the containing discussion.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| comments | To indicate which comment(s) in the discussion should be displayed | no | enum | all |
| discussionsize | The maximum number of comments to return per discussion | no | string | 1000 |
| returngroups | The groups to return in the output, can be none, user or all (administrator only includes all comments) | no | string | none |
| draft | If true include draft comment for current member (might return discussionsize + 1) | no | boolean | false |
comments
The comment display should be one of:
all– all comments in the discussionarchive– all comments including archived commentsfirst– only the first commentlast– only the last commentnone– no comments
If the comments parameters does not match one of the valid values, it is ignored.
Permission
This service can only be invoked by the own user or an administrator.
The member on the request needs to be a guest or higher. If the group of the discussion is public, anyone can invoke it while logged in.
Response
The output has the following format:
<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 id="201" type="text/plain">Some text
</content>
<attachment>
<uri id="189"> ... </uri>
</attachment>
<attachment fragment="5">
<uri id="289"> ... </uri>
</attachment>
[<group .../>...]
</comment>
</discussion>
Error Handling
| Code | Cause / Description |
|---|---|
| 0x1316 | The discussion was not found or invalid |