list uri fragment discussions
/members/{member}/uris/{uri}/fragments/{+fragment}/discussions [GET]
API Support | Available since | Last updated | Output |
---|---|---|---|
supported | 5.2101 | 5.9600 | xml, json |
Description
Load a list of discussions for a URI fragment.
Parameters
Name | Description | Required | Type | Default |
---|---|---|---|---|
attachedto | The comments to return that are attached to this URI | no | enum | all |
comments | Which comments to include | no | enum | all |
archived | If true , include discussions where all comments are archived | no | boolean | false |
results | The number of discussions/attachedtos to return | no | long | 1000 |
returngroups | The groups to return in the output | no | enum | none |
discussionsize | The maximum number of comments to return per discussion | no | long | 100 |
Comments parameter
The comment display must be one of:
all
– all comments in the discussionarchive
– all comments including archived commentsfirst
– only the first commentlast
– only the last commentnone
– no comments
Returngroups parameter
Must be one of:
none
– do not include the groupuser
– only include the group that the use belongs toall
(Only administrators can use this option)
Attachedto parameter
Must be one of:
none
all
Permission
The member on the request needs to be a guest or higher unless the URI is in a public group.
Response
The output has the following format:
<uri id="23"
type="..."
scheme="..."
host="..."
port="..."
path="..."
decodedpath="..."
mediatype="...">
<displaytitle>...</displaytitle>
<labels>...</labels>
<locator fragment="12">
<discussion id="123"
title="My thread"
replycount="3"
lastcommentid="234"
lastcommentdate="2012-08-20T14:27:48+10:00">
<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>
<attachedto>
<comment ...> ... </comment>
</attachedto>
...
</locator>
...
</uri>
Error Handling
Code | Cause / Description |
---|---|
0x6303 | Both URI and URL have been specified |
0x6304 | The URL is invalid |
Created on , last edited on