Trendsic Platform Service

PolicyRequiredDocumentRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator

The following routes are available for this service:
PUT,DELETE,OPTIONS	/v1/PolicyRequiredDocument/{Id}
POST,OPTIONS	/v1/PolicyRequiredDocument
GET	/v1/PolicyRequiredDocument/GetAllByPolicyAssociateId/{PolicyAssociateId}

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 PolicyDocumentStatus:
    id: int = 0
    name: Optional[str] = None
    is_n_b_c_status: bool = False
    is_agent_status: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PolicyRequiredDocument:
    id: int = 0
    policy_associate_id: Optional[str] = None
    policy_document_id: int = 0
    nbc_status_id: int = 0
    agent_status_id: int = 0
    status_options: List[PolicyDocumentStatus] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PolicyDocumentReminder:
    id: int = 0
    policy_document_id: int = 0
    reminder_for: Optional[str] = None
    reminder_lead_time: int = 0
    reminder_message: Optional[str] = None
    admin_agent_id: int = 0
    needs_prompt: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Reminder:
    reminder_id: Optional[str] = None
    table_name: Optional[str] = None
    field_name: Optional[str] = None
    record_id: int = 0
    reminder_date: datetime.datetime = datetime.datetime(1, 1, 1)
    reminder_note: Optional[str] = None
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    created_by: Optional[str] = None
    completed_date: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReminderExtended(Reminder):
    agent_name: Optional[str] = None
    record_agent_name: Optional[str] = None
    record_agent_i_d: int = 0
    is_admin: bool = False
    agent_i_d: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PolicyRequiredDocumentExtended(PolicyRequiredDocument):
    reminders: List[PolicyDocumentReminder] = field(default_factory=list)
    agent_reminders: List[ReminderExtended] = field(default_factory=list)


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PolicyRequiredDocumentRequest:
    policy_required_document: Optional[PolicyRequiredDocumentExtended] = None
    policy_associate_id: Optional[str] = None
    id: Optional[int] = None

Python PolicyRequiredDocumentRequest 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.

POST /v1/PolicyRequiredDocument HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	PolicyRequiredDocument: 
	{
		Reminders: 
		[
			{
				Id: 0,
				PolicyDocumentId: 0,
				ReminderFor: String,
				ReminderLeadTime: 0,
				ReminderMessage: String,
				AdminAgentId: 0,
				NeedsPrompt: False
			}
		],
		AgentReminders: 
		[
			{
				AgentName: String,
				RecordAgentName: String,
				RecordAgentID: 0,
				IsAdmin: False,
				AgentID: 0,
				ReminderId: 00000000000000000000000000000000,
				TableName: String,
				FieldName: String,
				RecordId: 0,
				ReminderDate: 0001-01-01,
				ReminderNote: String,
				CreatedDate: 0001-01-01,
				CreatedBy: String,
				CompletedDate: 0001-01-01
			}
		],
		Id: 0,
		PolicyAssociateId: 00000000000000000000000000000000,
		PolicyDocumentId: 0,
		NBCStatusId: 0,
		AgentStatusId: 0,
		StatusOptions: 
		[
			{
				Id: 0,
				Name: String,
				IsNBCStatus: False,
				IsAgentStatus: False
			}
		]
	},
	PolicyAssociateId: 00000000000000000000000000000000,
	Id: 0
}

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
		}
	},
	PolicyRequiredDocuments: 
	[
		{
			Reminders: 
			[
				{
					Id: 0,
					PolicyDocumentId: 0,
					ReminderFor: String,
					ReminderLeadTime: 0,
					ReminderMessage: String,
					AdminAgentId: 0,
					NeedsPrompt: False
				}
			],
			AgentReminders: 
			[
				{
					AgentName: String,
					RecordAgentName: String,
					RecordAgentID: 0,
					IsAdmin: False,
					AgentID: 0,
					ReminderId: 00000000000000000000000000000000,
					TableName: String,
					FieldName: String,
					RecordId: 0,
					ReminderDate: 0001-01-01,
					ReminderNote: String,
					CreatedDate: 0001-01-01,
					CreatedBy: String,
					CompletedDate: 0001-01-01
				}
			],
			Id: 0,
			PolicyAssociateId: 00000000000000000000000000000000,
			PolicyDocumentId: 0,
			NBCStatusId: 0,
			AgentStatusId: 0,
			StatusOptions: 
			[
				{
					Id: 0,
					Name: String,
					IsNBCStatus: False,
					IsAgentStatus: False
				}
			]
		}
	]
}