| GET | /internalrating/getratingleaderboardlist |
|---|
"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 RatingLeaderboardItem {
/** @param {{systemUserId?:number,profileImage?:string,fullName?:string,averageRating?:number,totalVotes?:number,position?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
systemUserId;
/** @type {string} */
profileImage;
/** @type {string} */
fullName;
/** @type {number} */
averageRating;
/** @type {number} */
totalVotes;
/** @type {string} */
position;
}
export class GetRatingLeaderboardResponse extends ApiServiceResponse {
/** @param {{leaderboardItems?:RatingLeaderboardItem[],myPosition?:number,description?:string,heading?:string,wasSuccessful?:boolean,modelState?:Object}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {RatingLeaderboardItem[]} */
leaderboardItems;
/** @type {number} */
myPosition;
}
export class GetRatingLeaderboard extends ApiServiceRequest {
/** @param {{apiKey?:string,latitude?:number,longitude?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
JavaScript GetRatingLeaderboard 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/getratingleaderboardlist HTTP/1.1 Host: cochraneplus-api-dev.happen.zone Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
leaderboardItems:
[
{
}
],
myPosition: 0,
description: String,
heading: String,
wasSuccessful: False,
modelState: {}
}