| GET | /internalrating/getusersratings |
|---|
"use strict";
export class ApiServiceRequest {
/** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The API Key required for authentication */
apiKey;
/**
* @type {number}
* @description Latitude of the user making this request */
latitude;
/**
* @type {number}
* @description Longitude of the user making this request */
longitude;
}
export class ApiServiceResponse {
/** @param {{description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
description;
/** @type {string} */
heading;
/** @type {boolean} */
wasSuccessful;
/** @type {Object} */
modelState;
}
export class RatingSubmissionListItem {
/** @param {{id?:number,profileImage?:string,templateName?:string,username?:string,value?:number,comments?:string,dateRated?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
profileImage;
/** @type {string} */
templateName;
/** @type {string} */
username;
/** @type {number} */
value;
/** @type {string} */
comments;
/** @type {string} */
dateRated;
}
export class GetRatingSubmissionsResponse extends ApiServiceResponse {
/** @param {{ratingSubmissions?:RatingSubmissionListItem[],description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {RatingSubmissionListItem[]} */
ratingSubmissions;
}
export class GetUsersRatings extends ApiServiceRequest {
/** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
JavaScript GetUsersRatings DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /internalrating/getusersratings HTTP/1.1 Host: cochraneplus-api-dev.happen.zone Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ratingSubmissions:
[
{
id: 0,
profileImage: String,
templateName: String,
username: String,
value: 0,
comments: String,
dateRated: 0001-01-01
}
],
description: String,
heading: String,
wasSuccessful: False,
modelState: {}
}