| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/SecuritiesSummary/DateRange/{ParamStartDate}/{ParamEndDate}/{AgentID} | ||
|---|---|---|---|
| GET,OPTIONS | /v1/SecuritiesSummary/DateRange/{ParamStartDate}/{ParamEndDate} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ListingSummary | query | List<ListingSummary> | No | |
| AgentID | path | int | No | |
| ParamStartDate | path | DateTime | No | |
| ParamEndDate | path | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AgentLevel | form | decimal | No | |
| AgentPoints | form | string | No | |
| AgentPolicyNumbers | form | string | No | |
| AgentYTDTotal | form | decimal | No | |
| AgentRTotal | form | decimal | No | |
| AgentOverallTotal | form | decimal | No | |
| AgentNextLevelPrerequired | form | decimal | No | |
| AgentCurrentYTDTotal | form | decimal | No | |
| AgentCurrentRunningTotal | form | decimal | No | |
| AgentLevelCalculatedFromListingPart | form | decimal | No | |
| AgentRequiredBeforeNextLevel | form | decimal | No | |
| AgentAdjustmentTotal | form | decimal | No | |
| AgentCommissionSubtotal | form | decimal | No | |
| AgentBalanceForward | form | decimal | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| ListingSummary | form | List<ListingSummary> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}