Trendsic Platform Service

<back to all web services

PolicyReportRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/PolicyReport/{PolicyNumber}
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 CommissionListing:
    id: int = 0
    process_date: datetime.datetime = datetime.datetime(1, 1, 1)
    payment_date: datetime.datetime = datetime.datetime(1, 1, 1)
    agent_id: int = 0
    agent: Optional[str] = None
    o_agent_i_d: int = 0
    o_agent: Optional[str] = None
    policy: Optional[str] = None
    policy_type: Optional[str] = None
    insured: Optional[str] = None
    premium: Decimal = decimal.Decimal(0)
    part: float = 0.0
    part_percent: float = 0.0
    amount: Decimal = decimal.Decimal(0)
    company: Optional[str] = None
    gross: Decimal = decimal.Decimal(0)
    agent_number: Optional[str] = None
    commission_rate: float = 0.0
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PolicyReportResponse:
    response_status: Optional[ResponseStatus] = None
    report_data: List[CommissionListing] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PolicyReportRequest:
    policy_number: Optional[str] = None

Python PolicyReportRequest 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/PolicyReport/{PolicyNumber} 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
		}
	},
	ReportData: 
	[
		{
			ID: 0,
			ProcessDate: 0001-01-01,
			PaymentDate: 0001-01-01,
			AgentId: 0,
			Agent: String,
			OAgentID: 0,
			OAgent: String,
			Policy: String,
			PolicyType: String,
			Insured: String,
			Premium: 0,
			Part: 0,
			PartPercent: 0,
			Amount: 0,
			Company: String,
			Gross: 0,
			AgentNumber: String,
			CommissionRate: 0,
			Description: String
		}
	]
}