Trendsic Platform Service

SecuritiesListingSummaryRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/SecuritiesSummary/DateRange/{ParamStartDate}/{ParamEndDate}/{AgentID}
GET,OPTIONS	/v1/SecuritiesSummary/DateRange/{ParamStartDate}/{ParamEndDate}

"use strict";
export class ListingSummary {
    /** @param {{AgentLevel?:number,AgentPoints?:string,AgentPolicyNumbers?:string,AgentYTDTotal?:number,AgentRTotal?:number,AgentOverallTotal?:number,AgentNextLevelPrerequired?:number,AgentCurrentYTDTotal?:number,AgentCurrentRunningTotal?:number,AgentLevelCalculatedFromListingPart?:number,AgentRequiredBeforeNextLevel?:number,AgentAdjustmentTotal?:number,AgentCommissionSubtotal?:number,AgentBalanceForward?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentLevel;
    /** @type {string} */
    AgentPoints;
    /** @type {string} */
    AgentPolicyNumbers;
    /** @type {number} */
    AgentYTDTotal;
    /** @type {number} */
    AgentRTotal;
    /** @type {number} */
    AgentOverallTotal;
    /** @type {number} */
    AgentNextLevelPrerequired;
    /** @type {number} */
    AgentCurrentYTDTotal;
    /** @type {number} */
    AgentCurrentRunningTotal;
    /** @type {number} */
    AgentLevelCalculatedFromListingPart;
    /** @type {number} */
    AgentRequiredBeforeNextLevel;
    /** @type {number} */
    AgentAdjustmentTotal;
    /** @type {number} */
    AgentCommissionSubtotal;
    /** @type {number} */
    AgentBalanceForward;
}
export class ListingSummaryResponse {
    /** @param {{ResponseStatus?:ResponseStatus,ListingSummary?:ListingSummary[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {ListingSummary[]} */
    ListingSummary = [];
}
export class SecuritiesListingSummaryRequest {
    /** @param {{ListingSummary?:ListingSummary[],AgentID?:number,ParamStartDate?:string,ParamEndDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ListingSummary[]} */
    ListingSummary = [];
    /** @type {number} */
    AgentID;
    /** @type {string} */
    ParamStartDate;
    /** @type {string} */
    ParamEndDate;
}

JavaScript SecuritiesListingSummaryRequest DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/SecuritiesSummary/DateRange/{ParamStartDate}/{ParamEndDate}/{AgentID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"ListingSummary":[{"AgentLevel":0,"AgentPoints":"String","AgentPolicyNumbers":"String","AgentYTDTotal":0,"AgentRTotal":0,"AgentOverallTotal":0,"AgentNextLevelPrerequired":0,"AgentCurrentYTDTotal":0,"AgentCurrentRunningTotal":0,"AgentLevelCalculatedFromListingPart":0,"AgentRequiredBeforeNextLevel":0,"AgentAdjustmentTotal":0,"AgentCommissionSubtotal":0,"AgentBalanceForward":0}]}