| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,OPTIONS | /v1/PolicyDocumentReminder/{PolicyDocumentId} | ||
|---|---|---|---|
| DELETE,OPTIONS | /v1/PolicyDocumentReminder/{Id} | ||
| POST,PUT,OPTIONS | /v1/PolicyDocumentReminder/ |
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 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 PolicyDocumentReminderResponse:
response_status: Optional[ResponseStatus] = None
policy_document_reminder: List[PolicyDocumentReminder] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PolicyDocumentReminderRequest:
id: int = 0
policy_document_id: int = 0
reminder: Optional[PolicyDocumentReminder] = None
Python PolicyDocumentReminderRequest 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/PolicyDocumentReminder/ HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PolicyDocumentReminderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Id>0</Id>
<PolicyDocumentId>0</PolicyDocumentId>
<Reminder>
<AdminAgentId>0</AdminAgentId>
<Id>0</Id>
<NeedsPrompt>false</NeedsPrompt>
<PolicyDocumentId>0</PolicyDocumentId>
<ReminderFor>String</ReminderFor>
<ReminderLeadTime>0</ReminderLeadTime>
<ReminderMessage>String</ReminderMessage>
</Reminder>
</PolicyDocumentReminderRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<PolicyDocumentReminderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<PolicyDocumentReminder>
<PolicyDocumentReminder>
<AdminAgentId>0</AdminAgentId>
<Id>0</Id>
<NeedsPrompt>false</NeedsPrompt>
<PolicyDocumentId>0</PolicyDocumentId>
<ReminderFor>String</ReminderFor>
<ReminderLeadTime>0</ReminderLeadTime>
<ReminderMessage>String</ReminderMessage>
</PolicyDocumentReminder>
</PolicyDocumentReminder>
<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>
</PolicyDocumentReminderResponse>