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}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class ActivityPlan
            Public Overridable Property Id As Integer
            Public Overridable Property AgentId As Integer
            Public Overridable Property EventTypeId As Integer
            Public Overridable Property Goal As Integer
            Public Overridable Property DateFrom As Date
            Public Overridable Property DateTo As Date
            Public Overridable Property DateCreated As Date
            Public Overridable Property MthlyCashFlow As Integer
            Public Overridable Property YTDCashFlow As Integer
            Public Overridable Property Recruit As Integer
            Public Overridable Property EventTypeName As String
            Public Overridable Property Actual As Integer
        End Class

        Public Partial Class ActivityPlanExtended
            Public Overridable Property AppCount As Integer
            Public Overridable Property AvgFlow As Integer
            Public Overridable Property AvgTransfer As Integer
            Public Overridable Property AvgLife As Integer
            Public Overridable Property LifePerAnnuity As Decimal
            Public Overridable Property FlowTransfer As Decimal
            Public Overridable Property TransferRatio As Decimal
        End Class

        Public Partial Class ActivityPlanRequest
            Public Overridable Property ActivityPlan As ActivityPlan
            Public Overridable Property AgentId As Integer
            Public Overridable Property DateFrom As Date
            Public Overridable Property DateTo As Date
            Public Overridable Property ApplicationGoal As Integer
            Public Overridable Property AppointmentSetGoal As Integer
            Public Overridable Property LearningGoal As Integer
            Public Overridable Property MarketingGoal As Integer
            Public Overridable Property ReferralGoal As Integer
            Public Overridable Property LeadGoal As Integer
            Public Overridable Property ClientUpdateGoal As Integer
            Public Overridable Property FirstContactGoal As Integer
            Public Overridable Property FirstAppointmentGoal As Integer
            Public Overridable Property SecondAppointmentGoal As Integer
            Public Overridable Property SecondAppointmentSetGoal As Integer
            Public Overridable Property MonthlyCashFlowGoal As Integer
            Public Overridable Property YTDCashFlowGoal As Integer
            Public Overridable Property RecruitGoal As Integer
        End Class

        Public Partial Class ActivityPlanResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property ActivityPlans As List(Of ActivityPlan) = New List(Of ActivityPlan)
            Public Overridable Property ActivityData As ActivityPlanExtended
        End Class
    End Namespace
End Namespace

VB.NET 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}}