Loading ...

REST API: Get Comment List | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Comments » REST API: Get Comment List
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 17

REST API: Get Comment List

0 
 /5
0 (0votes)

Get comment list

GET /api/comments

Returns a list of comments based on the parameters specified in the url. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
Optional Parameters How to use Description
ParentID &parentid=x - Used in the request URL (see below) Unique ID of the parent comment.
SpaceID &spaceid=x - Used in the request URL (see below) ID of the space from which the comments are to be returned.
EntityID &entityid=x - Used in the request URL (see below)
 Unique identifier for a particular entity.
EntityType &entitytype=x - Used in the request URL (see below) The entity type of the content whose comments are to be returned. Here are the values of EntityType parameter:
  • Article = 3
  • Blog = 4
  • Photo = 6
  • Video = 7
  • Wiki = 9
  • CMSPage = 12
  • File = 14
  • Idea = 44
Status &status=x - Used in the request URL (see below) Status of the comment. Here are the values of Status parameter:
  • PendingWorkflow = 0
  • Published = 1
  • Spam = 2
  • Declined = 3
  • All = 7
UserID &userid=x - Used in the request URL (see below) ID of the user whose comments are to be returned.
SortColumn &sortcolumn=x - Used in the request URL (see below) Sort comment based on a column. Here are the values of SortColumn parameter:
  • Unspecified = 0
  • DateCreated = 1
  • Rating = 2
  • DatePublished = 3
  • DateUpdated = 4
  • ViewCount = 5
  • CommentCount = 6
  • EventStartDate = 7
  • SortOrder = 8
  • VoteCount = 9
  • ContentTitle = 10
  • DateAwarded = 11
  • TagCount = 12
  • MostRelavant = 13
SortOrder &sortorder=x - Used in the request URL (see below) The order in which comments are to be sorted. Here are the values of the SortOrder parameter:
  • Ascending = 0
  • Descending = 1
  • Unspecified = 2
StartPage &startpage=x - Used in the request URL (see below) Specifies the starting page of list to be returned.
PageLength &pagelength=x - Used in the request URL (see below) Specifies the number of results to be returned per page.

Example URL to GET: http://your-community.com/api/comments?entityid=2317&startpage=1&pagelength=100

Response JSON sample where comment list JSON object is returned as ResponseData

Here is an example of JSON data returned from the API call. Note that some properties are removed from this sample to make it shorter.


{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData":
                        [
                            {
                                "CommentText":"All of that paperwork should be in the Files section of the Human Resources space.",
                                "CommentTextUnprocessed":"All of that paperwork should be in the Files section of the Human Resources space.",
                                "CommentTitle":null,
                                "CommentID":584,
                                "ParentCommentID":0,
                                "EntityType":0,
                                "CommentEntityType":0,
                                "EntityID":2317,
                                "RatingID":null,
                                "CommentRating":0.0,
                                "UserEmail":"acme@acme.com",
                                "UserMediaServerRootURL":null,
                                "ParentEntityAuthorID":0,
                                "UserID":1,
                                "CommentStatus":1,
                                "UserWebsite":"",
                                "UserIPAddress":"::1",
                                "UserName":"jhon",
                                "UserFirstName":null,
                                "UserLastName":null,
                                "UserAvatarFileName":null,
                                "DateCommented":"2016-02-03T08:18:06.21",
                                "DateCommentedText":"3 seconds ago",
                                "DateTimeISO":"2016-02-03T13:48:06.2100000",
                                "DateTimeFull":"Wednesday, February 3, 2016 at 01:48",
                                "UserAvatarVirtualPath":"http://your-community.com/Assets/Uploaded-Photos/884af119-4937-4b33-a795-826cda3d19a3.png",
                                "UserProfileURL":"http://your-community.com/people/jhon",
                                "UserDisplayName":"Jhon Smith",
                                "CaptchaCode":null,
                                "IsInternal":false,
                                "CanUserDeleteComment":true,
                                "CurrentWorkFlowStepID":0,
                                "WorkFlowID":0,
                                "CanUserChangeCommentStatus":false,
                                "SpaceID":0,
                                "NestedComments":[],
                                "CommentTextHtmlFormatted":"All of that paperwork should be in the Files section of the Human Resources space.",
                                "CommentTextFormatted":"All of that paperwork should be in the Files section of the Human Resources space."
                            },
                            {
                                "CommentText":"Yeah I can't find it anywhere.",
                                "CommentTextUnprocessed":"Yeah I can't find it anywhere.",
                                "CommentTitle":null,
                                "CommentID":583,
                                "ParentCommentID":0,
                                "EntityType":0,
                                "CommentEntityType":0,
                                "EntityID":2317,
                                "RatingID":null,
                                "CommentRating":0.0,
                                "UserEmail":"acme@acme.com",
                                "UserMediaServerRootURL":null,
                                "ParentEntityAuthorID":0,
                                "UserID":1,
                                "CommentStatus":1,
                                "UserWebsite":"",
                                "UserIPAddress":"::1",
                                "UserName":"jhon",
                                "UserFirstName":null,
                                "UserLastName":null,
                                "UserAvatarFileName":null,
                                "DateCommented":"2016-02-03T08:18:04.357",
                                "DateCommentedText":"5 seconds ago",
                                "DateTimeISO":"2016-02-03T13:48:04.3570000",
                                "DateTimeFull":"Wednesday, February 3, 2016 at 01:48",
                                "UserAvatarVirtualPath":"http://your-community.com/Assets/Uploaded-Photos/884af119-4937-4b33-a795-826cda3d19a3.png\",
                                "UserProfileURL":"http://your-community.com/people/jhon",
                                "UserDisplayName":"Jhon Smith",
                                "CaptchaCode":null,
                                "IsInternal":false,
                                "CanUserDeleteComment":true,
                                "CurrentWorkFlowStepID":0,
                                "WorkFlowID":0,
                                "CanUserChangeCommentStatus":false,
                                "SpaceID":0,
                                "NestedComments":[],
                                "CommentTextHtmlFormatted":"Yeah I can't find it anywhere.",
                                "CommentTextFormatted":"Yeah I can't find it anywhere."
                        }
                    ]
}


Please Note Your content type that you pass in the header of your request should be 'application/json'.

 

Wiki Index

Pages

Intranet Software