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}
LeaderboardRequest Parameters:
NameParameterData TypeRequiredDescription
StartDatepathstringNo
EndDatepathstringNo
LeaderboardTypepathstringNo
LeaderboardResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
AllDataformList<Leaderboard>No
MVPformList<Leaderboard>No
AVPformList<Leaderboard>No
RVPformList<Leaderboard>No
AgentsformList<Leaderboard>No
Leaderboard Parameters:
NameParameterData TypeRequiredDescription
PositionformintNo
NameformstringNo
LocationformstringNo
LifeCashFlowformdecimalNo
AnnuityCashFlowformdecimalNo
TotalCashFlowformdecimalNo
PremiumLifeformdecimalNo
PremiumAnnuityformdecimalNo
PointsLifeformdecimalNo
PointsAnnuityformdecimalNo
TotalPointsformdecimalNo
IsMVPformboolNo
IsRVPformboolNo
IsAVPformboolNo
IsAgentformboolNo
PhoneformstringNo
Upline1NameformstringNo
Upline2NameformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

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

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