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}
ActivityPlanRequest Parameters:
NameParameterData TypeRequiredDescription
ActivityPlanbodyActivityPlanNo
AgentIdpathintNo
DateFrompathDateTimeNo
DateTopathDateTimeNo
ApplicationGoalbodyintNo
AppointmentSetGoalbodyintNo
LearningGoalbodyintNo
MarketingGoalbodyintNo
ReferralGoalbodyintNo
LeadGoalbodyintNo
ClientUpdateGoalbodyintNo
FirstContactGoalbodyintNo
FirstAppointmentGoalbodyintNo
SecondAppointmentGoalbodyintNo
SecondAppointmentSetGoalbodyintNo
MonthlyCashFlowGoalbodyintNo
YTDCashFlowGoalbodyintNo
RecruitGoalbodyintNo
ActivityPlan Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
AgentIdformintNo
EventTypeIdformintNo
GoalformintNo
DateFromformDateTimeNo
DateToformDateTimeNo
DateCreatedformDateTimeNo
MthlyCashFlowformintNo
YTDCashFlowformintNo
RecruitformintNo
EventTypeNameformstringNo
ActualformintNo
ActivityPlanResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ActivityPlansformList<ActivityPlan>No
ActivityDataformActivityPlanExtendedNo
ActivityPlanExtended Parameters:
NameParameterData TypeRequiredDescription
AppCountformintNo
AvgFlowformintNo
AvgTransferformintNo
AvgLifeformintNo
LifePerAnnuityformdecimalNo
FlowTransferformdecimalNo
TransferRatioformdecimalNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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: application/json
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}}