| POST,OPTIONS | /v1/Leaderboard | ||
|---|---|---|---|
| GET,OPTIONS | /v1/Leaderboard/{LeaderboardType}/{StartDate}/{EndDate} |
"use strict";
export class Leaderboard {
/** @param {{Position?:number,Name?:string,Location?:string,LifeCashFlow?:number,AnnuityCashFlow?:number,TotalCashFlow?:number,PremiumLife?:number,PremiumAnnuity?:number,PointsLife?:number,PointsAnnuity?:number,TotalPoints?:number,IsMVP?:boolean,IsRVP?:boolean,IsAVP?:boolean,IsAgent?:boolean,Phone?:string,Upline1Name?:string,Upline2Name?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Position;
/** @type {string} */
Name;
/** @type {string} */
Location;
/** @type {number} */
LifeCashFlow;
/** @type {number} */
AnnuityCashFlow;
/** @type {number} */
TotalCashFlow;
/** @type {number} */
PremiumLife;
/** @type {number} */
PremiumAnnuity;
/** @type {number} */
PointsLife;
/** @type {number} */
PointsAnnuity;
/** @type {number} */
TotalPoints;
/** @type {boolean} */
IsMVP;
/** @type {boolean} */
IsRVP;
/** @type {boolean} */
IsAVP;
/** @type {boolean} */
IsAgent;
/** @type {string} */
Phone;
/** @type {string} */
Upline1Name;
/** @type {string} */
Upline2Name;
}
export class LeaderboardResponse {
/** @param {{ResponseStatus?:ResponseStatus,AllData?:Leaderboard[],MVP?:Leaderboard[],AVP?:Leaderboard[],RVP?:Leaderboard[],Agents?:Leaderboard[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {Leaderboard[]} */
AllData = [];
/** @type {Leaderboard[]} */
MVP = [];
/** @type {Leaderboard[]} */
AVP = [];
/** @type {Leaderboard[]} */
RVP = [];
/** @type {Leaderboard[]} */
Agents = [];
}
export class LeaderboardRequest {
/** @param {{StartDate?:string,EndDate?:string,LeaderboardType?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
StartDate;
/** @type {string} */
EndDate;
/** @type {string} */
LeaderboardType;
}
JavaScript LeaderboardRequest 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.
POST /v1/Leaderboard HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
StartDate: String,
EndDate: String,
LeaderboardType: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
AllData:
[
{
Position: 0,
Name: String,
Location: String,
LifeCashFlow: 0,
AnnuityCashFlow: 0,
TotalCashFlow: 0,
PremiumLife: 0,
PremiumAnnuity: 0,
PointsLife: 0,
PointsAnnuity: 0,
TotalPoints: 0,
IsMVP: False,
IsRVP: False,
IsAVP: False,
IsAgent: False,
Phone: String,
Upline1Name: String,
Upline2Name: String
}
],
MVP:
[
{
Position: 0,
Name: String,
Location: String,
LifeCashFlow: 0,
AnnuityCashFlow: 0,
TotalCashFlow: 0,
PremiumLife: 0,
PremiumAnnuity: 0,
PointsLife: 0,
PointsAnnuity: 0,
TotalPoints: 0,
IsMVP: False,
IsRVP: False,
IsAVP: False,
IsAgent: False,
Phone: String,
Upline1Name: String,
Upline2Name: String
}
],
AVP:
[
{
Position: 0,
Name: String,
Location: String,
LifeCashFlow: 0,
AnnuityCashFlow: 0,
TotalCashFlow: 0,
PremiumLife: 0,
PremiumAnnuity: 0,
PointsLife: 0,
PointsAnnuity: 0,
TotalPoints: 0,
IsMVP: False,
IsRVP: False,
IsAVP: False,
IsAgent: False,
Phone: String,
Upline1Name: String,
Upline2Name: String
}
],
RVP:
[
{
Position: 0,
Name: String,
Location: String,
LifeCashFlow: 0,
AnnuityCashFlow: 0,
TotalCashFlow: 0,
PremiumLife: 0,
PremiumAnnuity: 0,
PointsLife: 0,
PointsAnnuity: 0,
TotalPoints: 0,
IsMVP: False,
IsRVP: False,
IsAVP: False,
IsAgent: False,
Phone: String,
Upline1Name: String,
Upline2Name: String
}
],
Agents:
[
{
Position: 0,
Name: String,
Location: String,
LifeCashFlow: 0,
AnnuityCashFlow: 0,
TotalCashFlow: 0,
PremiumLife: 0,
PremiumAnnuity: 0,
PointsLife: 0,
PointsAnnuity: 0,
TotalPoints: 0,
IsMVP: False,
IsRVP: False,
IsAVP: False,
IsAgent: False,
Phone: String,
Upline1Name: String,
Upline2Name: String
}
]
}