Trendsic Platform Service

<back to all web services

PolicyDocumentReminderRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
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 .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/PolicyDocumentReminder/ HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	PolicyDocumentId: 0,
	Reminder: 
	{
		Id: 0,
		PolicyDocumentId: 0,
		ReminderFor: String,
		ReminderLeadTime: 0,
		ReminderMessage: String,
		AdminAgentId: 0,
		NeedsPrompt: False
	}
}
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
		}
	},
	PolicyDocumentReminder: 
	[
		{
			Id: 0,
			PolicyDocumentId: 0,
			ReminderFor: String,
			ReminderLeadTime: 0,
			ReminderMessage: String,
			AdminAgentId: 0,
			NeedsPrompt: False
		}
	]
}