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}
"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 .xml suffix or ?format=xml

HTTP + XML

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

<LeaderboardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <EndDate>String</EndDate>
  <LeaderboardType>String</LeaderboardType>
  <StartDate>String</StartDate>
</LeaderboardRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LeaderboardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AVP>
    <Leaderboard>
      <_AnnuityCashFlow>0</_AnnuityCashFlow>
      <_IsAVP>false</_IsAVP>
      <_IsAgent>false</_IsAgent>
      <_IsMVP>false</_IsMVP>
      <_IsRVP>false</_IsRVP>
      <_LifeCashFlow>0</_LifeCashFlow>
      <_Location>String</_Location>
      <_Name>String</_Name>
      <_Phone>String</_Phone>
      <_PointsAnnuity>0</_PointsAnnuity>
      <_PointsLife>0</_PointsLife>
      <_Position>0</_Position>
      <_PremiumAnnuity>0</_PremiumAnnuity>
      <_PremiumLife>0</_PremiumLife>
      <_TotalCashFlow>0</_TotalCashFlow>
      <_TotalPoints>0</_TotalPoints>
      <_Upline1Name>String</_Upline1Name>
      <_Upline2Name>String</_Upline2Name>
    </Leaderboard>
  </AVP>
  <Agents>
    <Leaderboard>
      <_AnnuityCashFlow>0</_AnnuityCashFlow>
      <_IsAVP>false</_IsAVP>
      <_IsAgent>false</_IsAgent>
      <_IsMVP>false</_IsMVP>
      <_IsRVP>false</_IsRVP>
      <_LifeCashFlow>0</_LifeCashFlow>
      <_Location>String</_Location>
      <_Name>String</_Name>
      <_Phone>String</_Phone>
      <_PointsAnnuity>0</_PointsAnnuity>
      <_PointsLife>0</_PointsLife>
      <_Position>0</_Position>
      <_PremiumAnnuity>0</_PremiumAnnuity>
      <_PremiumLife>0</_PremiumLife>
      <_TotalCashFlow>0</_TotalCashFlow>
      <_TotalPoints>0</_TotalPoints>
      <_Upline1Name>String</_Upline1Name>
      <_Upline2Name>String</_Upline2Name>
    </Leaderboard>
  </Agents>
  <AllData>
    <Leaderboard>
      <_AnnuityCashFlow>0</_AnnuityCashFlow>
      <_IsAVP>false</_IsAVP>
      <_IsAgent>false</_IsAgent>
      <_IsMVP>false</_IsMVP>
      <_IsRVP>false</_IsRVP>
      <_LifeCashFlow>0</_LifeCashFlow>
      <_Location>String</_Location>
      <_Name>String</_Name>
      <_Phone>String</_Phone>
      <_PointsAnnuity>0</_PointsAnnuity>
      <_PointsLife>0</_PointsLife>
      <_Position>0</_Position>
      <_PremiumAnnuity>0</_PremiumAnnuity>
      <_PremiumLife>0</_PremiumLife>
      <_TotalCashFlow>0</_TotalCashFlow>
      <_TotalPoints>0</_TotalPoints>
      <_Upline1Name>String</_Upline1Name>
      <_Upline2Name>String</_Upline2Name>
    </Leaderboard>
  </AllData>
  <MVP>
    <Leaderboard>
      <_AnnuityCashFlow>0</_AnnuityCashFlow>
      <_IsAVP>false</_IsAVP>
      <_IsAgent>false</_IsAgent>
      <_IsMVP>false</_IsMVP>
      <_IsRVP>false</_IsRVP>
      <_LifeCashFlow>0</_LifeCashFlow>
      <_Location>String</_Location>
      <_Name>String</_Name>
      <_Phone>String</_Phone>
      <_PointsAnnuity>0</_PointsAnnuity>
      <_PointsLife>0</_PointsLife>
      <_Position>0</_Position>
      <_PremiumAnnuity>0</_PremiumAnnuity>
      <_PremiumLife>0</_PremiumLife>
      <_TotalCashFlow>0</_TotalCashFlow>
      <_TotalPoints>0</_TotalPoints>
      <_Upline1Name>String</_Upline1Name>
      <_Upline2Name>String</_Upline2Name>
    </Leaderboard>
  </MVP>
  <RVP>
    <Leaderboard>
      <_AnnuityCashFlow>0</_AnnuityCashFlow>
      <_IsAVP>false</_IsAVP>
      <_IsAgent>false</_IsAgent>
      <_IsMVP>false</_IsMVP>
      <_IsRVP>false</_IsRVP>
      <_LifeCashFlow>0</_LifeCashFlow>
      <_Location>String</_Location>
      <_Name>String</_Name>
      <_Phone>String</_Phone>
      <_PointsAnnuity>0</_PointsAnnuity>
      <_PointsLife>0</_PointsLife>
      <_Position>0</_Position>
      <_PremiumAnnuity>0</_PremiumAnnuity>
      <_PremiumLife>0</_PremiumLife>
      <_TotalCashFlow>0</_TotalCashFlow>
      <_TotalPoints>0</_TotalPoints>
      <_Upline1Name>String</_Upline1Name>
      <_Upline2Name>String</_Upline2Name>
    </Leaderboard>
  </RVP>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</LeaderboardResponse>