<back to all web services

CommentsFilterExtended

The following routes are available for this service:
POST/RestApi/comments-api/comments/filter
"use strict";
export class CommentResponse {
    /** @param {{Key?:string,Name?:string,Message?:string,DateCreated?:string,ProfilePictureUrl?:string,ProfilePictureThumbnailUrl?:string,Status?:string,Email?:string,ThreadKey?:string,AuthorIpAddress?:string,CustomData?:string,Rating?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    Name;
    /** @type {string} */
    Message;
    /** @type {string} */
    DateCreated;
    /** @type {string} */
    ProfilePictureUrl;
    /** @type {string} */
    ProfilePictureThumbnailUrl;
    /** @type {string} */
    Status;
    /** @type {string} */
    Email;
    /** @type {string} */
    ThreadKey;
    /** @type {string} */
    AuthorIpAddress;
    /** @type {string} */
    CustomData;
    /** @type {?number} */
    Rating;
}
export class CommentsFilterExtended {
    /** @param {{CommentKey?:string[],ThreadKey?:string[],Language?:string[],AuthorKey?:string[],Status?:string[],ThreadType?:string[],Behavior?:string[],GroupKey?:string[],Skip?:number,Take?:number,SortDescending?:boolean,NewerThan?:string,OlderThan?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string[]} */
    CommentKey;
    /** @type {string[]} */
    ThreadKey;
    /** @type {string[]} */
    Language;
    /** @type {string[]} */
    AuthorKey;
    /** @type {string[]} */
    Status;
    /** @type {string[]} */
    ThreadType;
    /** @type {string[]} */
    Behavior;
    /** @type {string[]} */
    GroupKey;
    /** @type {number} */
    Skip;
    /** @type {number} */
    Take;
    /** @type {boolean} */
    SortDescending;
    /** @type {string} */
    NewerThan;
    /** @type {string} */
    OlderThan;
}
/** @typedef CommentResponse {any} */
export class CollectionResponse {
    /** @param {{TotalCount?:number,Items?:CommentResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    TotalCount;
    /** @type {CommentResponse[]} */
    Items;
}

JavaScript CommentsFilterExtended DTOs

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>