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

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class ActivityPlan
    {
        public virtual int Id { get; set; }
        public virtual int AgentId { get; set; }
        public virtual int EventTypeId { get; set; }
        public virtual int Goal { get; set; }
        public virtual DateTime DateFrom { get; set; }
        public virtual DateTime DateTo { get; set; }
        public virtual DateTime DateCreated { get; set; }
        public virtual int MthlyCashFlow { get; set; }
        public virtual int YTDCashFlow { get; set; }
        public virtual int Recruit { get; set; }
        public virtual string EventTypeName { get; set; }
        public virtual int Actual { get; set; }
    }

    public partial class ActivityPlanExtended
    {
        public virtual int AppCount { get; set; }
        public virtual int AvgFlow { get; set; }
        public virtual int AvgTransfer { get; set; }
        public virtual int AvgLife { get; set; }
        public virtual decimal LifePerAnnuity { get; set; }
        public virtual decimal FlowTransfer { get; set; }
        public virtual decimal TransferRatio { get; set; }
    }

    public partial class ActivityPlanRequest
    {
        public virtual ActivityPlan ActivityPlan { get; set; }
        public virtual int AgentId { get; set; }
        public virtual DateTime DateFrom { get; set; }
        public virtual DateTime DateTo { get; set; }
        public virtual int ApplicationGoal { get; set; }
        public virtual int AppointmentSetGoal { get; set; }
        public virtual int LearningGoal { get; set; }
        public virtual int MarketingGoal { get; set; }
        public virtual int ReferralGoal { get; set; }
        public virtual int LeadGoal { get; set; }
        public virtual int ClientUpdateGoal { get; set; }
        public virtual int FirstContactGoal { get; set; }
        public virtual int FirstAppointmentGoal { get; set; }
        public virtual int SecondAppointmentGoal { get; set; }
        public virtual int SecondAppointmentSetGoal { get; set; }
        public virtual int MonthlyCashFlowGoal { get; set; }
        public virtual int YTDCashFlowGoal { get; set; }
        public virtual int RecruitGoal { get; set; }
    }

    public partial class ActivityPlanResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<ActivityPlan> ActivityPlans { get; set; } = [];
        public virtual ActivityPlanExtended ActivityData { get; set; }
    }

}

C# ActivityPlanRequest DTOs

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

HTTP + JSV

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

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