Trendsic Platform Service

<back to all web services

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}

export class ActivityPlan
{
    public Id: number;
    public AgentId: number;
    public EventTypeId: number;
    public Goal: number;
    public DateFrom: string;
    public DateTo: string;
    public DateCreated: string;
    public MthlyCashFlow: number;
    public YTDCashFlow: number;
    public Recruit: number;
    public EventTypeName: string;
    public Actual: number;

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

export class ActivityPlanExtended
{
    public AppCount: number;
    public AvgFlow: number;
    public AvgTransfer: number;
    public AvgLife: number;
    public LifePerAnnuity: number;
    public FlowTransfer: number;
    public TransferRatio: number;

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

export class ActivityPlanResponse
{
    public ResponseStatus: ResponseStatus;
    public ActivityPlans: ActivityPlan[] = [];
    public ActivityData: ActivityPlanExtended;

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

export class ActivityPlanRequest
{
    public ActivityPlan: ActivityPlan;
    public AgentId: number;
    public DateFrom: string;
    public DateTo: string;
    public ApplicationGoal: number;
    public AppointmentSetGoal: number;
    public LearningGoal: number;
    public MarketingGoal: number;
    public ReferralGoal: number;
    public LeadGoal: number;
    public ClientUpdateGoal: number;
    public FirstContactGoal: number;
    public FirstAppointmentGoal: number;
    public SecondAppointmentGoal: number;
    public SecondAppointmentSetGoal: number;
    public MonthlyCashFlowGoal: number;
    public YTDCashFlowGoal: number;
    public RecruitGoal: number;

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

TypeScript ActivityPlanRequest DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ActivityPlan":{"Id":0,"AgentId":0,"EventTypeId":0,"Goal":0,"DateFrom":"0001-01-01T00:00:00.0000000","DateTo":"0001-01-01T00:00:00.0000000","DateCreated":"0001-01-01T00:00:00.0000000","MthlyCashFlow":0,"YTDCashFlow":0,"Recruit":0,"EventTypeName":"String","Actual":0},"AgentId":0,"DateFrom":"0001-01-01T00:00:00.0000000","DateTo":"0001-01-01T00:00:00.0000000","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/jsonl
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-01T00:00:00.0000000","DateTo":"0001-01-01T00:00:00.0000000","DateCreated":"0001-01-01T00:00:00.0000000","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}}