POST | /RestApi/reviews-api |
---|
"use strict";
export class GroupCreateRequest {
/** @param {{Key?:string,Name?:string,Description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Key;
/** @type {string} */
Name;
/** @type {string} */
Description;
}
export class ThreadCreateRequest {
/** @param {{Key?:string,Type?:string,Behavior?:string,Title?:string,Language?:string,DataSource?:string,GroupKey?:string,Group?:GroupCreateRequest}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Key;
/** @type {string} */
Type;
/** @type {string} */
Behavior;
/** @type {string} */
Title;
/** @type {string} */
Language;
/** @type {string} */
DataSource;
/** @type {string} */
GroupKey;
/** @type {GroupCreateRequest} */
Group;
}
export class CaptchaInfo {
/** @param {{Answer?:string,CorrectAnswer?:string,InitializationVector?:string,Key?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Answer;
/** @type {string} */
CorrectAnswer;
/** @type {string} */
InitializationVector;
/** @type {string} */
Key;
}
export class ReviewCreateRequest {
/** @param {{Message?:string,Name?:string,Email?:string,CustomData?:string,ThreadKey?:string,Thread?:ThreadCreateRequest,Captcha?:CaptchaInfo,Rating?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Message;
/** @type {string} */
Name;
/** @type {string} */
Email;
/** @type {string} */
CustomData;
/** @type {string} */
ThreadKey;
/** @type {ThreadCreateRequest} */
Thread;
/** @type {CaptchaInfo} */
Captcha;
/** @type {?number} */
Rating;
}
export class ReviewViewModel {
/** @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;
}
JavaScript ReviewCreateRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /RestApi/reviews-api HTTP/1.1
Host: www.asg.com.au
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Message":"String","Name":"String","Email":"String","CustomData":"String","ThreadKey":"String","Thread":{"Key":"String","Type":"String","Behavior":"String","Title":"String","Language":"String","DataSource":"String","GroupKey":"String","Group":{"Key":"String","Name":"String","Description":"String"}},"Captcha":{"Answer":"String","CorrectAnswer":"String","InitializationVector":"String","Key":"String"},"Rating":0}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"Key":"String","Name":"String","Message":"String","DateCreated":"\/Date(-62135596800000-0000)\/","ProfilePictureUrl":"String","ProfilePictureThumbnailUrl":"String","Status":"String","Email":"String","ThreadKey":"String","AuthorIpAddress":"String","CustomData":"String","Rating":0}