GET api.ashx/v2/comments/threaded.{json|xml}
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
ChildPageSize | int | Query String | Specifies the number of child records to return per first level comment. Max of 50. | Optional | 10 | |
CommentId | Guid | Query String | Comment Id | Required | ||
CommentTypeId | Guid | Query String | Comment type Id | Optional | ||
CommentTypeId | Guid | Query String | Comment type Id | Optional | ||
ContentId | Guid | Query String | Content Id. Either ContentUrl or ContentId and ContentTypeId are required | Optional | ||
ContentId | Guid | Query String | Content Id. Either ContentUrl or ContentId and ContentTypeId are required | Optional | ||
ContentTypeId | Guid | Query String | Content Type Id | Optional | ||
ContentTypeId | Guid | Query String | Content Type Id | Optional | ||
ContentUrl | string | Query String | The URL at which the content can be accessed. Either ContentUrl or ContentId and ContentTypeId are required | Optional | ||
ContentUrl | string | Query String | The URL at which the content can be accessed. Either ContentUrl or ContentId and ContentTypeId are required | Optional | ||
CreatedEndDate | DateTime | Query String | Created end date. Only filters first level of comments returned. | Optional | ||
CreatedStartDate | DateTime | Query String | Created start date. Only filters first level of comments returned. | Optional | ||
Direction | string | Query String | Specifies the direction paging occurs, either up from the CommentId passed in to the root comment, or down from the root comment for the CommentId passed in. 'FromRootComment', 'FromComment' | Optional | FromComment | |
EndCommentId | Guid | Query String | End Comment Id | Optional | ||
FlattenedDepth | int | Query String | Specify the depth at which all child comments will be wrapped under the last level of threaded comments. Zero-based index. Max of 9. | Optional | 2 | |
FlattenedDepth | int | Query String | Specify the depth at which all child comments will be wrapped under the last level of threaded comments. Zero-based index. Max of 9. | Optional | 2 | |
FlattenedSortBy | string | Query String | Sort of flattened comments. Sort options include CreatedDate, Votes | Optional | ||
FlattenedSortBy | string | Query String | Sort of flattened comments. Sort options include CreatedDate, Votes | Optional | ||
FlattenedSortOrder | string | Query String | Sort order of flattened comments. 'Ascending' or 'Descending' | Optional | ||
FlattenedSortOrder | string | Query String | Sort order of flattened comments. 'Ascending' or 'Descending' | Optional | ||
PageSize | int | Query String | Number of comments to return. Max of 100. | Optional | 20 | |
ParentCommentId | Guid | Query String | Parent Comment Id | Optional | ||
PostTarget | string | Query String | Render target. Options: Unknown, Web, Syndication, Offline, Other, Print, Nntp, Email, WebQuote, WebServices. | Optional | ||
PostTarget | string | Query String | Render target. Options: Unknown, Web, Syndication, Offline, Other, Print, Nntp, Email, WebQuote, WebServices. | Optional | ||
RootPageSize | int | Query String | Number of first level comments to return. Max of 100. | Optional | 20 | |
StartCommentId | Guid | Query String | Start Comment Id | Optional | ||
ThreadedSortBy | string | Query String | Sort threaded comments by. Sort options include CreatedDate, Votes | Optional | ||
ThreadedSortBy | string | Query String | Sort threaded comments by. Sort options include CreatedDate, Votes | Optional | ||
ThreadedSortOrder | string | Query String | Sort order of threaded comments returned. 'Ascending' or 'Descending' | Optional | ||
ThreadedSortOrder | string | Query String | Sort order of threaded comments returned. 'Ascending' or 'Descending' | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/comments/threaded.json?CommentId=49fec544-6df7-4a82-872b-f8be586d5e9e', data: { 'CommentId': '49fec544-6df7-4a82-872b-f8be586d5e9e' } }).then(function(response) { // use response });