Trendsic Platform Service

<back to all web services

LeaderboardRequest

The following routes are available for this service:
POST,OPTIONS/v1/Leaderboard
GET,OPTIONS/v1/Leaderboard/{LeaderboardType}/{StartDate}/{EndDate}

export class Leaderboard
{
    public Position: number;
    public Name: string;
    public Location: string;
    public LifeCashFlow: number;
    public AnnuityCashFlow: number;
    public TotalCashFlow: number;
    public PremiumLife: number;
    public PremiumAnnuity: number;
    public PointsLife: number;
    public PointsAnnuity: number;
    public TotalPoints: number;
    public IsMVP: boolean;
    public IsRVP: boolean;
    public IsAVP: boolean;
    public IsAgent: boolean;
    public Phone: string;
    public Upline1Name: string;
    public Upline2Name: string;

    public constructor(init?: Partial<Leaderboard>) { (Object as any).assign(this, init); }
}

export class LeaderboardResponse
{
    public ResponseStatus: ResponseStatus;
    public AllData: Leaderboard[] = [];
    public MVP: Leaderboard[] = [];
    public AVP: Leaderboard[] = [];
    public RVP: Leaderboard[] = [];
    public Agents: Leaderboard[] = [];

    public constructor(init?: Partial<LeaderboardResponse>) { (Object as any).assign(this, init); }
}

export class LeaderboardRequest
{
    public StartDate: string;
    public EndDate: string;
    public LeaderboardType: string;

    public constructor(init?: Partial<LeaderboardRequest>) { (Object as any).assign(this, init); }
}

TypeScript LeaderboardRequest DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"StartDate":"String","EndDate":"String","LeaderboardType":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}]}