<back to all web services

CommentsFilterExtended

The following routes are available for this service:
POST/RestApi/comments-api/comments/filter
CommentsFilterExtended Parameters:
NameParameterData TypeRequiredDescription
CommentKeybodyList<string>No
ThreadKeybodyList<string>No
LanguagebodyList<string>No
AuthorKeybodyList<string>No
StatusbodyList<string>No
ThreadTypebodyList<string>No
BehaviorbodyList<string>No
GroupKeybodyList<string>No
SkipbodyintNo
TakebodyintNo
SortDescendingbodyboolNo
NewerThanbodyDateTimeNo
OlderThanbodyDateTimeNo
CollectionResponse<CommentResponse> Parameters:
NameParameterData TypeRequiredDescription
TotalCountformintNo
ItemsformIEnumerable<CommentResponse>No
CommentResponse Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
NameformstringNo
MessageformstringNo
DateCreatedformDateTimeNo
ProfilePictureUrlformstringNo
ProfilePictureThumbnailUrlformstringNo
StatusformstringNo
EmailformstringNo
ThreadKeyformstringNo
AuthorIpAddressformstringNo
CustomDataformstringNo
Ratingformdecimal?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /RestApi/comments-api/comments/filter HTTP/1.1 
Host: www.asg.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CommentsFilterExtended xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Services.Comments.DTO">
  <AuthorKey xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AuthorKey>
  <Behavior xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Behavior>
  <CommentKey xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CommentKey>
  <GroupKey xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </GroupKey>
  <Language xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Language>
  <NewerThan>0001-01-01T00:00:00</NewerThan>
  <OlderThan>0001-01-01T00:00:00</OlderThan>
  <Skip>0</Skip>
  <SortDescending>false</SortDescending>
  <Status xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Status>
  <Take>0</Take>
  <ThreadKey xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ThreadKey>
  <ThreadType xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ThreadType>
</CommentsFilterExtended>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CollectionResponseOfCommentResponseXvaRN2Ag xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Services.Comments.DTO">
  <Items i:nil="true" />
  <TotalCount>0</TotalCount>
</CollectionResponseOfCommentResponseXvaRN2Ag>