| Requires any of the roles: | Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/ListingSummary/{ID} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/ListingSummary | ||
| GET,POST,PUT,DELETE,OPTIONS | /v1/ListingSummary/DateRange/{ParamStartDate}/{ParamEndDate}/{AgentID} | ||
| GET,POST,PUT,DELETE,OPTIONS | /v1/ListingSummary/DateRange/{ParamStartDate}/{ParamEndDate} |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListingSummary:
agent_level: Decimal = decimal.Decimal(0)
agent_points: Optional[str] = None
agent_policy_numbers: Optional[str] = None
agent_y_t_d_total: Decimal = decimal.Decimal(0)
agent_r_total: Decimal = decimal.Decimal(0)
agent_overall_total: Decimal = decimal.Decimal(0)
agent_next_level_prerequired: Decimal = decimal.Decimal(0)
agent_current_y_t_d_total: Decimal = decimal.Decimal(0)
agent_current_running_total: Decimal = decimal.Decimal(0)
agent_level_calculated_from_listing_part: Decimal = decimal.Decimal(0)
agent_required_before_next_level: Decimal = decimal.Decimal(0)
agent_adjustment_total: Decimal = decimal.Decimal(0)
agent_commission_subtotal: Decimal = decimal.Decimal(0)
agent_balance_forward: Decimal = decimal.Decimal(0)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListingSummaryResponse:
response_status: Optional[ResponseStatus] = None
listing_summary: List[ListingSummary] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListingSummaryRequest:
listing_summary: List[ListingSummary] = field(default_factory=list)
agent_i_d: int = 0
param_start_date: datetime.datetime = datetime.datetime(1, 1, 1)
param_end_date: datetime.datetime = datetime.datetime(1, 1, 1)
Python ListingSummaryRequest DTOs
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.
POST /v1/ListingSummary/{ID} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
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
}
],
AgentID: 0,
ParamStartDate: 0001-01-01,
ParamEndDate: 0001-01-01
}
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
}
]
}