| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| 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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<PolicyRequiredDocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Id>0</Id>
<PolicyAssociateId>00000000-0000-0000-0000-000000000000</PolicyAssociateId>
<PolicyRequiredDocument>
<AgentStatusId>0</AgentStatusId>
<Id>0</Id>
<NBCStatusId>0</NBCStatusId>
<PolicyAssociateId>00000000-0000-0000-0000-000000000000</PolicyAssociateId>
<PolicyDocumentId>0</PolicyDocumentId>
<StatusOptions>
<PolicyDocumentStatus>
<Id>0</Id>
<IsAgentStatus>false</IsAgentStatus>
<IsNBCStatus>false</IsNBCStatus>
<Name>String</Name>
</PolicyDocumentStatus>
</StatusOptions>
<AgentReminders>
<ReminderExtended>
<CompletedDate>0001-01-01T00:00:00</CompletedDate>
<CreatedBy>String</CreatedBy>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<FieldName>String</FieldName>
<RecordId>0</RecordId>
<ReminderDate>0001-01-01T00:00:00</ReminderDate>
<ReminderId>00000000-0000-0000-0000-000000000000</ReminderId>
<ReminderNote>String</ReminderNote>
<TableName>String</TableName>
<AgentID>0</AgentID>
<AgentName>String</AgentName>
<IsAdmin>false</IsAdmin>
<RecordAgentID>0</RecordAgentID>
<RecordAgentName>String</RecordAgentName>
</ReminderExtended>
</AgentReminders>
<Reminders>
<PolicyDocumentReminder>
<AdminAgentId>0</AdminAgentId>
<Id>0</Id>
<NeedsPrompt>false</NeedsPrompt>
<PolicyDocumentId>0</PolicyDocumentId>
<ReminderFor>String</ReminderFor>
<ReminderLeadTime>0</ReminderLeadTime>
<ReminderMessage>String</ReminderMessage>
</PolicyDocumentReminder>
</Reminders>
</PolicyRequiredDocument>
</PolicyRequiredDocumentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<PolicyRequiredDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<PolicyRequiredDocuments>
<PolicyRequiredDocumentExtended>
<AgentStatusId>0</AgentStatusId>
<Id>0</Id>
<NBCStatusId>0</NBCStatusId>
<PolicyAssociateId>00000000-0000-0000-0000-000000000000</PolicyAssociateId>
<PolicyDocumentId>0</PolicyDocumentId>
<StatusOptions>
<PolicyDocumentStatus>
<Id>0</Id>
<IsAgentStatus>false</IsAgentStatus>
<IsNBCStatus>false</IsNBCStatus>
<Name>String</Name>
</PolicyDocumentStatus>
</StatusOptions>
<AgentReminders>
<ReminderExtended>
<CompletedDate>0001-01-01T00:00:00</CompletedDate>
<CreatedBy>String</CreatedBy>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<FieldName>String</FieldName>
<RecordId>0</RecordId>
<ReminderDate>0001-01-01T00:00:00</ReminderDate>
<ReminderId>00000000-0000-0000-0000-000000000000</ReminderId>
<ReminderNote>String</ReminderNote>
<TableName>String</TableName>
<AgentID>0</AgentID>
<AgentName>String</AgentName>
<IsAdmin>false</IsAdmin>
<RecordAgentID>0</RecordAgentID>
<RecordAgentName>String</RecordAgentName>
</ReminderExtended>
</AgentReminders>
<Reminders>
<PolicyDocumentReminder>
<AdminAgentId>0</AdminAgentId>
<Id>0</Id>
<NeedsPrompt>false</NeedsPrompt>
<PolicyDocumentId>0</PolicyDocumentId>
<ReminderFor>String</ReminderFor>
<ReminderLeadTime>0</ReminderLeadTime>
<ReminderMessage>String</ReminderMessage>
</PolicyDocumentReminder>
</Reminders>
</PolicyRequiredDocumentExtended>
</PolicyRequiredDocuments>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</PolicyRequiredDocumentResponse>