Trendsic Platform Service

<back to all web services

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}

export class ListingSummary
{
    public AgentLevel: number;
    public AgentPoints: string;
    public AgentPolicyNumbers: string;
    public AgentYTDTotal: number;
    public AgentRTotal: number;
    public AgentOverallTotal: number;
    public AgentNextLevelPrerequired: number;
    public AgentCurrentYTDTotal: number;
    public AgentCurrentRunningTotal: number;
    public AgentLevelCalculatedFromListingPart: number;
    public AgentRequiredBeforeNextLevel: number;
    public AgentAdjustmentTotal: number;
    public AgentCommissionSubtotal: number;
    public AgentBalanceForward: number;

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

export class ListingSummaryResponse
{
    public ResponseStatus: ResponseStatus;
    public ListingSummary: ListingSummary[] = [];

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

export class SecuritiesListingSummaryRequest
{
    public ListingSummary: ListingSummary[] = [];
    public AgentID: number;
    public ParamStartDate: string;
    public ParamEndDate: string;

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

TypeScript 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}]}