Trendsic Platform Service

ActivityPlanRequest

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

The following routes are available for this service:
POST,OPTIONS	/v1/ActivityPlan
GET,OPTIONS	/v1/ActivityPlan/{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 ActivityPlanRequest {
    /** @param {{ActivityPlan?:ActivityPlan,AgentId?:number,DateFrom?:string,DateTo?:string,ApplicationGoal?:number,AppointmentSetGoal?:number,LearningGoal?:number,MarketingGoal?:number,ReferralGoal?:number,LeadGoal?:number,ClientUpdateGoal?:number,FirstContactGoal?:number,FirstAppointmentGoal?:number,SecondAppointmentGoal?:number,SecondAppointmentSetGoal?:number,MonthlyCashFlowGoal?:number,YTDCashFlowGoal?:number,RecruitGoal?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ActivityPlan} */
    ActivityPlan;
    /** @type {number} */
    AgentId;
    /** @type {string} */
    DateFrom;
    /** @type {string} */
    DateTo;
    /** @type {number} */
    ApplicationGoal;
    /** @type {number} */
    AppointmentSetGoal;
    /** @type {number} */
    LearningGoal;
    /** @type {number} */
    MarketingGoal;
    /** @type {number} */
    ReferralGoal;
    /** @type {number} */
    LeadGoal;
    /** @type {number} */
    ClientUpdateGoal;
    /** @type {number} */
    FirstContactGoal;
    /** @type {number} */
    FirstAppointmentGoal;
    /** @type {number} */
    SecondAppointmentGoal;
    /** @type {number} */
    SecondAppointmentSetGoal;
    /** @type {number} */
    MonthlyCashFlowGoal;
    /** @type {number} */
    YTDCashFlowGoal;
    /** @type {number} */
    RecruitGoal;
}

JavaScript ActivityPlanRequest 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.

POST /v1/ActivityPlan HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ActivityPlan: 
	{
		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
	},
	AgentId: 0,
	DateFrom: 0001-01-01,
	DateTo: 0001-01-01,
	ApplicationGoal: 0,
	AppointmentSetGoal: 0,
	LearningGoal: 0,
	MarketingGoal: 0,
	ReferralGoal: 0,
	LeadGoal: 0,
	ClientUpdateGoal: 0,
	FirstContactGoal: 0,
	FirstAppointmentGoal: 0,
	SecondAppointmentGoal: 0,
	SecondAppointmentSetGoal: 0,
	MonthlyCashFlowGoal: 0,
	YTDCashFlowGoal: 0,
	RecruitGoal: 0
}

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