<back to all web services

CommentGetRequest

The following routes are available for this service:
GET/RestApi/comments-api/comments/{key}
"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 CommentGetRequest {
    /** @param {{Key?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
}

JavaScript CommentGetRequest DTOs

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

HTTP + JSV

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

GET /RestApi/comments-api/comments/{key} HTTP/1.1 
Host: www.asg.com.au 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Key: String,
	Name: String,
	Message: String,
	DateCreated: 0001-01-01,
	ProfilePictureUrl: String,
	ProfilePictureThumbnailUrl: String,
	Status: String,
	Email: String,
	ThreadKey: String,
	AuthorIpAddress: String,
	CustomData: String,
	Rating: 0
}