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


open class SecuritiesListingSummaryRequest
{
    open var ListingSummary:ArrayList<ListingSummary> = ArrayList<ListingSummary>()
    open var AgentID:Int? = null
    open var ParamStartDate:Date? = null
    open var ParamEndDate:Date? = null
}

open class ListingSummary
{
    open var AgentLevel:BigDecimal? = null
    open var AgentPoints:String? = null
    open var AgentPolicyNumbers:String? = null
    open var AgentYTDTotal:BigDecimal? = null
    open var AgentRTotal:BigDecimal? = null
    open var AgentOverallTotal:BigDecimal? = null
    open var AgentNextLevelPrerequired:BigDecimal? = null
    open var AgentCurrentYTDTotal:BigDecimal? = null
    open var AgentCurrentRunningTotal:BigDecimal? = null
    open var AgentLevelCalculatedFromListingPart:BigDecimal? = null
    open var AgentRequiredBeforeNextLevel:BigDecimal? = null
    open var AgentAdjustmentTotal:BigDecimal? = null
    open var AgentCommissionSubtotal:BigDecimal? = null
    open var AgentBalanceForward:BigDecimal? = null
}

open class ListingSummaryResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var ListingSummary:ArrayList<ListingSummary> = ArrayList<ListingSummary>()
}

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