Trendsic Platform Service

<back to all web services

ActivityDataLast6MonthsRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/ActivityDataLast6Months/{AgentId}/{DateFrom}/{DateTo}
"use strict";
export class ActivityPlan {
    /** @param {{Id?:number,AgentId?:number,EventTypeId?:number,Goal?:number,DateFrom?:string,DateTo?:string,DateCreated?:string,MthlyCashFlow?:number,YTDCashFlow?:number,Recruit?:number,EventTypeName?:string,Actual?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    AgentId;
    /** @type {number} */
    EventTypeId;
    /** @type {number} */
    Goal;
    /** @type {string} */
    DateFrom;
    /** @type {string} */
    DateTo;
    /** @type {string} */
    DateCreated;
    /** @type {number} */
    MthlyCashFlow;
    /** @type {number} */
    YTDCashFlow;
    /** @type {number} */
    Recruit;
    /** @type {string} */
    EventTypeName;
    /** @type {number} */
    Actual;
}
export class ActivityPlanExtended {
    /** @param {{AppCount?:number,AvgFlow?:number,AvgTransfer?:number,AvgLife?:number,LifePerAnnuity?:number,FlowTransfer?:number,TransferRatio?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AppCount;
    /** @type {number} */
    AvgFlow;
    /** @type {number} */
    AvgTransfer;
    /** @type {number} */
    AvgLife;
    /** @type {number} */
    LifePerAnnuity;
    /** @type {number} */
    FlowTransfer;
    /** @type {number} */
    TransferRatio;
}
export class ActivityPlanResponse {
    /** @param {{ResponseStatus?:ResponseStatus,ActivityPlans?:ActivityPlan[],ActivityData?:ActivityPlanExtended}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {ActivityPlan[]} */
    ActivityPlans = [];
    /** @type {ActivityPlanExtended} */
    ActivityData;
}
export class ActivityDataLast6MonthsRequest {
    /** @param {{AgentId?:number,DateFrom?:string,DateTo?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentId;
    /** @type {string} */
    DateFrom;
    /** @type {string} */
    DateTo;
}

JavaScript ActivityDataLast6MonthsRequest DTOs

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

HTTP + JSV

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

GET /v1/ActivityDataLast6Months/{AgentId}/{DateFrom}/{DateTo} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	ActivityPlans: 
	[
		{
			Id: 0,
			AgentId: 0,
			EventTypeId: 0,
			Goal: 0,
			DateFrom: 0001-01-01,
			DateTo: 0001-01-01,
			DateCreated: 0001-01-01,
			MthlyCashFlow: 0,
			YTDCashFlow: 0,
			Recruit: 0,
			EventTypeName: String,
			Actual: 0
		}
	],
	ActivityData: 
	{
		AppCount: 0,
		AvgFlow: 0,
		AvgTransfer: 0,
		AvgLife: 0,
		LifePerAnnuity: 0,
		FlowTransfer: 0,
		TransferRatio: 0
	}
}