GET api/1/Comments/GetAllComments?SortOrder={SortOrder}&ResourceKey={ResourceKey}&UserToken={UserToken}

Gets all the comments for the application identified by the calling URL.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SortOrder

Which way to sort the comments.

CommentsSortOrderEnum

Required

ResourceKey

The key identifying the resource for which to get comments.

string

Required

UserToken

The user's auth token issued by the server.

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of CommentPoco
NameDescriptionTypeAdditional information
ID

integer

None.

ParentID

integer

None.

Application_ResourceID

integer

None.

UserID

integer

None.

CommentText

string

None.

Forum

string

None.

IsFlagged

boolean

None.

IsDeleted

boolean

None.

IsApproved

boolean

None.

Likes

integer

None.

DisLikes

integer

None.

IsEdited

boolean

None.

Points

integer

None.

CommentDepth

integer

None.

DateCreated

date

None.

UserToken

string

None.

UserDisplayName

string

None.

UserDisplayImage

string

None.

ResponseToUserDisplayName

string

None.

IsMine

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "UserDisplayName": "sample string 1",
    "UserDisplayImage": "sample string 2",
    "ResponseToUserDisplayName": "sample string 3",
    "IsMine": true,
    "ID": 1,
    "ParentID": 1,
    "Application_ResourceID": 2,
    "UserID": 1,
    "CommentText": "sample string 3",
    "Forum": "sample string 4",
    "IsFlagged": true,
    "IsDeleted": true,
    "IsApproved": true,
    "Likes": 8,
    "DisLikes": 9,
    "IsEdited": true,
    "Points": 11,
    "CommentDepth": 1,
    "DateCreated": "2018-12-11T04:02:30.990427-06:00",
    "UserToken": "sample string 13"
  },
  {
    "UserDisplayName": "sample string 1",
    "UserDisplayImage": "sample string 2",
    "ResponseToUserDisplayName": "sample string 3",
    "IsMine": true,
    "ID": 1,
    "ParentID": 1,
    "Application_ResourceID": 2,
    "UserID": 1,
    "CommentText": "sample string 3",
    "Forum": "sample string 4",
    "IsFlagged": true,
    "IsDeleted": true,
    "IsApproved": true,
    "Likes": 8,
    "DisLikes": 9,
    "IsEdited": true,
    "Points": 11,
    "CommentDepth": 1,
    "DateCreated": "2018-12-11T04:02:30.990427-06:00",
    "UserToken": "sample string 13"
  }
]

application/xml, text/xml

Sample:
<ArrayOfCommentPoco xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RCS.DataAccess">
  <CommentPoco>
    <Application_ResourceID>2</Application_ResourceID>
    <CommentDepth>1</CommentDepth>
    <CommentText>sample string 3</CommentText>
    <DateCreated>2018-12-11T04:02:30.990427-06:00</DateCreated>
    <DisLikes>9</DisLikes>
    <Forum>sample string 4</Forum>
    <ID>1</ID>
    <IsApproved>true</IsApproved>
    <IsDeleted>true</IsDeleted>
    <IsEdited>true</IsEdited>
    <IsFlagged>true</IsFlagged>
    <IsMine>true</IsMine>
    <Likes>8</Likes>
    <ParentID>1</ParentID>
    <Points>11</Points>
    <ResponseToUserDisplayName>sample string 3</ResponseToUserDisplayName>
    <UserDisplayImage>sample string 2</UserDisplayImage>
    <UserDisplayName>sample string 1</UserDisplayName>
    <UserID>1</UserID>
    <UserToken>sample string 13</UserToken>
  </CommentPoco>
  <CommentPoco>
    <Application_ResourceID>2</Application_ResourceID>
    <CommentDepth>1</CommentDepth>
    <CommentText>sample string 3</CommentText>
    <DateCreated>2018-12-11T04:02:30.990427-06:00</DateCreated>
    <DisLikes>9</DisLikes>
    <Forum>sample string 4</Forum>
    <ID>1</ID>
    <IsApproved>true</IsApproved>
    <IsDeleted>true</IsDeleted>
    <IsEdited>true</IsEdited>
    <IsFlagged>true</IsFlagged>
    <IsMine>true</IsMine>
    <Likes>8</Likes>
    <ParentID>1</ParentID>
    <Points>11</Points>
    <ResponseToUserDisplayName>sample string 3</ResponseToUserDisplayName>
    <UserDisplayImage>sample string 2</UserDisplayImage>
    <UserDisplayName>sample string 1</UserDisplayName>
    <UserID>1</UserID>
    <UserToken>sample string 13</UserToken>
  </CommentPoco>
</ArrayOfCommentPoco>

text/javascript, application/javascript, application/json-p

Sample:
([{"UserDisplayName":"sample string 1","UserDisplayImage":"sample string 2","ResponseToUserDisplayName":"sample string 3","IsMine":true,"ID":1,"ParentID":1,"Application_ResourceID":2,"UserID":1,"CommentText":"sample string 3","Forum":"sample string 4","IsFlagged":true,"IsDeleted":true,"IsApproved":true,"Likes":8,"DisLikes":9,"IsEdited":true,"Points":11,"CommentDepth":1,"DateCreated":"2018-12-11T04:02:30.990427-06:00","UserToken":"sample string 13"},{"UserDisplayName":"sample string 1","UserDisplayImage":"sample string 2","ResponseToUserDisplayName":"sample string 3","IsMine":true,"ID":1,"ParentID":1,"Application_ResourceID":2,"UserID":1,"CommentText":"sample string 3","Forum":"sample string 4","IsFlagged":true,"IsDeleted":true,"IsApproved":true,"Likes":8,"DisLikes":9,"IsEdited":true,"Points":11,"CommentDepth":1,"DateCreated":"2018-12-11T04:02:30.990427-06:00","UserToken":"sample string 13"}]);