<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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"CommentKey":["String"],"ThreadKey":["String"],"Language":["String"],"AuthorKey":["String"],"Status":["String"],"ThreadType":["String"],"Behavior":["String"],"GroupKey":["String"],"Skip":0,"Take":0,"SortDescending":false,"NewerThan":"\/Date(-62135596800000-0000)\/","OlderThan":"\/Date(-62135596800000-0000)\/"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"TotalCount":0}