Trendsic Platform Service

<back to all web services

SecuritiesListingSummaryRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/SecuritiesSummary/DateRange/{ParamStartDate}/{ParamEndDate}/{AgentID}
GET,OPTIONS/v1/SecuritiesSummary/DateRange/{ParamStartDate}/{ParamEndDate}
import Foundation
import ServiceStack

public class SecuritiesListingSummaryRequest : Codable
{
    public var listingSummary:[ListingSummary] = []
    public var agentID:Int
    public var paramStartDate:Date
    public var paramEndDate:Date

    required public init(){}
}

public class ListingSummary : Codable
{
    public var agentLevel:Double
    public var agentPoints:String
    public var agentPolicyNumbers:String
    public var agentYTDTotal:Double
    public var agentRTotal:Double
    public var agentOverallTotal:Double
    public var agentNextLevelPrerequired:Double
    public var agentCurrentYTDTotal:Double
    public var agentCurrentRunningTotal:Double
    public var agentLevelCalculatedFromListingPart:Double
    public var agentRequiredBeforeNextLevel:Double
    public var agentAdjustmentTotal:Double
    public var agentCommissionSubtotal:Double
    public var agentBalanceForward:Double

    required public init(){}
}

public class ListingSummaryResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var listingSummary:[ListingSummary] = []

    required public init(){}
}


Swift SecuritiesListingSummaryRequest 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/SecuritiesSummary/DateRange/{ParamStartDate}/{ParamEndDate}/{AgentID} 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
		}
	},
	ListingSummary: 
	[
		{
			AgentLevel: 0,
			AgentPoints: String,
			AgentPolicyNumbers: String,
			AgentYTDTotal: 0,
			AgentRTotal: 0,
			AgentOverallTotal: 0,
			AgentNextLevelPrerequired: 0,
			AgentCurrentYTDTotal: 0,
			AgentCurrentRunningTotal: 0,
			AgentLevelCalculatedFromListingPart: 0,
			AgentRequiredBeforeNextLevel: 0,
			AgentAdjustmentTotal: 0,
			AgentCommissionSubtotal: 0,
			AgentBalanceForward: 0
		}
	]
}