list uri discussions
/members/{member}/uris/{uri}/discussions [GET]
API Support | Available since | Last updated | Output |
---|---|---|---|
5.2101 | 5.9600 | xml, json |
Description
Load a list of discussions for a URI, including all discussions attached to fragments in that URI.
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 | Whether to include discussions/attachedtos where all comments are archived (true if comments=archive ) | 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 should be one of:
all
– all comments in the discussion (default)archive
– all comments including archived commentsfirst
– only the first commentlast
– only the last commentnone
– no comments
Returngroups parameter
Must be one of:
all
(Only administrators can use this option)none
– do not include the group (default)user
– only include the group that the user belongs to
Attachedto parameter
Must be one of:
all
(default)none
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 (<count>
is only returned on external URIs for users with edit all URLs permission):
<uri id="23" type="..." scheme="..." host="..." port="..." path="..." decodedpath="..." mediatype="..."> <displaytitle> ... </displaytitle> <labels> ... </labels> [<count discussions-all-groups="12" attachedtos-all-groups="23" />] <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> [<group .../> ...] </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 |