| Requires any of the roles: | Worker, Agent, Administrator, Worker, Agent, Administrator |
| 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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<ActivityPlanRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ActivityPlan>
<Actual>0</Actual>
<AgentId>0</AgentId>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateFrom>0001-01-01T00:00:00</DateFrom>
<DateTo>0001-01-01T00:00:00</DateTo>
<EventTypeId>0</EventTypeId>
<EventTypeName>String</EventTypeName>
<Goal>0</Goal>
<Id>0</Id>
<MthlyCashFlow>0</MthlyCashFlow>
<Recruit>0</Recruit>
<YTDCashFlow>0</YTDCashFlow>
</ActivityPlan>
<AgentId>0</AgentId>
<ApplicationGoal>0</ApplicationGoal>
<AppointmentSetGoal>0</AppointmentSetGoal>
<ClientUpdateGoal>0</ClientUpdateGoal>
<DateFrom>0001-01-01T00:00:00</DateFrom>
<DateTo>0001-01-01T00:00:00</DateTo>
<FirstAppointmentGoal>0</FirstAppointmentGoal>
<FirstContactGoal>0</FirstContactGoal>
<LeadGoal>0</LeadGoal>
<LearningGoal>0</LearningGoal>
<MarketingGoal>0</MarketingGoal>
<MonthlyCashFlowGoal>0</MonthlyCashFlowGoal>
<RecruitGoal>0</RecruitGoal>
<ReferralGoal>0</ReferralGoal>
<SecondAppointmentGoal>0</SecondAppointmentGoal>
<SecondAppointmentSetGoal>0</SecondAppointmentSetGoal>
<YTDCashFlowGoal>0</YTDCashFlowGoal>
</ActivityPlanRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ActivityPlanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ActivityData>
<AppCount>0</AppCount>
<AvgFlow>0</AvgFlow>
<AvgLife>0</AvgLife>
<AvgTransfer>0</AvgTransfer>
<FlowTransfer>0</FlowTransfer>
<LifePerAnnuity>0</LifePerAnnuity>
<TransferRatio>0</TransferRatio>
</ActivityData>
<ActivityPlans>
<ActivityPlan>
<Actual>0</Actual>
<AgentId>0</AgentId>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateFrom>0001-01-01T00:00:00</DateFrom>
<DateTo>0001-01-01T00:00:00</DateTo>
<EventTypeId>0</EventTypeId>
<EventTypeName>String</EventTypeName>
<Goal>0</Goal>
<Id>0</Id>
<MthlyCashFlow>0</MthlyCashFlow>
<Recruit>0</Recruit>
<YTDCashFlow>0</YTDCashFlow>
</ActivityPlan>
</ActivityPlans>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</ActivityPlanResponse>