Trendsic Platform Service

<back to all web services

ActivityDataRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/ActivityData/{AgentId}/{DateFrom}/{DateTo}
import Foundation
import ServiceStack

public class ActivityDataRequest : Codable
{
    public var agentId:Int
    public var dateFrom:Date
    public var dateTo:Date

    required public init(){}
}

public class ActivityPlanResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var activityPlans:[ActivityPlan] = []
    public var activityData:ActivityPlanExtended

    required public init(){}
}

public class ActivityPlan : Codable
{
    public var id:Int
    public var agentId:Int
    public var eventTypeId:Int
    public var goal:Int
    public var dateFrom:Date
    public var dateTo:Date
    public var dateCreated:Date
    public var mthlyCashFlow:Int
    public var ytdCashFlow:Int
    public var recruit:Int
    public var eventTypeName:String
    public var actual:Int

    required public init(){}
}

public class ActivityPlanExtended : Codable
{
    public var appCount:Int
    public var avgFlow:Int
    public var avgTransfer:Int
    public var avgLife:Int
    public var lifePerAnnuity:Double
    public var flowTransfer:Double
    public var transferRatio:Double

    required public init(){}
}


Swift ActivityDataRequest 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.

GET /v1/ActivityData/{AgentId}/{DateFrom}/{DateTo} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
	}
}