Trendsic Platform Service

<back to all web services

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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class PolicyRequiredDocumentRequest
{
    open var PolicyRequiredDocument:PolicyRequiredDocumentExtended? = null
    open var PolicyAssociateId:UUID? = null
    open var Id:Int? = null
}

open class PolicyRequiredDocumentExtended : PolicyRequiredDocument()
{
    open var Reminders:ArrayList<PolicyDocumentReminder> = ArrayList<PolicyDocumentReminder>()
    open var AgentReminders:ArrayList<ReminderExtended> = ArrayList<ReminderExtended>()
}

open class PolicyRequiredDocument
{
    open var Id:Int? = null
    open var PolicyAssociateId:UUID? = null
    open var PolicyDocumentId:Int? = null
    open var NBCStatusId:Int? = null
    open var AgentStatusId:Int? = null
    open var StatusOptions:ArrayList<PolicyDocumentStatus> = ArrayList<PolicyDocumentStatus>()
}

open class PolicyDocumentStatus
{
    open var Id:Int? = null
    open var Name:String? = null
    open var IsNBCStatus:Boolean? = null
    open var IsAgentStatus:Boolean? = null
}

open class PolicyDocumentReminder
{
    open var Id:Int? = null
    open var PolicyDocumentId:Int? = null
    open var ReminderFor:String? = null
    open var ReminderLeadTime:Int? = null
    open var ReminderMessage:String? = null
    open var AdminAgentId:Int? = null
    open var NeedsPrompt:Boolean? = null
}

open class ReminderExtended : Reminder()
{
    open var AgentName:String? = null
    open var RecordAgentName:String? = null
    open var RecordAgentID:Int? = null
    open var IsAdmin:Boolean? = null
    open var AgentID:Int? = null
}

open class Reminder
{
    open var ReminderId:UUID? = null
    open var TableName:String? = null
    open var FieldName:String? = null
    open var RecordId:Int? = null
    open var ReminderDate:Date? = null
    open var ReminderNote:String? = null
    open var CreatedDate:Date? = null
    open var CreatedBy:String? = null
    open var CompletedDate:Date? = null
}

open class PolicyRequiredDocumentResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var PolicyRequiredDocuments:ArrayList<PolicyRequiredDocumentExtended> = ArrayList<PolicyRequiredDocumentExtended>()
}

Kotlin 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
				}
			]
		}
	]
}