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}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class ActivityPlanRequest
{
    open var ActivityPlan:ActivityPlan? = null
    open var AgentId:Int? = null
    open var DateFrom:Date? = null
    open var DateTo:Date? = null
    open var ApplicationGoal:Int? = null
    open var AppointmentSetGoal:Int? = null
    open var LearningGoal:Int? = null
    open var MarketingGoal:Int? = null
    open var ReferralGoal:Int? = null
    open var LeadGoal:Int? = null
    open var ClientUpdateGoal:Int? = null
    open var FirstContactGoal:Int? = null
    open var FirstAppointmentGoal:Int? = null
    open var SecondAppointmentGoal:Int? = null
    open var SecondAppointmentSetGoal:Int? = null
    open var MonthlyCashFlowGoal:Int? = null
    open var YTDCashFlowGoal:Int? = null
    open var RecruitGoal:Int? = null
}

open class ActivityPlan
{
    open var Id:Int? = null
    open var AgentId:Int? = null
    open var EventTypeId:Int? = null
    open var Goal:Int? = null
    open var DateFrom:Date? = null
    open var DateTo:Date? = null
    open var DateCreated:Date? = null
    open var MthlyCashFlow:Int? = null
    open var YTDCashFlow:Int? = null
    open var Recruit:Int? = null
    open var EventTypeName:String? = null
    open var Actual:Int? = null
}

open class ActivityPlanResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var ActivityPlans:ArrayList<ActivityPlan> = ArrayList<ActivityPlan>()
    open var ActivityData:ActivityPlanExtended? = null
}

open class ActivityPlanExtended
{
    open var AppCount:Int? = null
    open var AvgFlow:Int? = null
    open var AvgTransfer:Int? = null
    open var AvgLife:Int? = null
    open var LifePerAnnuity:BigDecimal? = null
    open var FlowTransfer:BigDecimal? = null
    open var TransferRatio:BigDecimal? = null
}

Kotlin ActivityPlanRequest DTOs

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