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.*;

public class dtos
{

    public static class PolicyRequiredDocumentRequest
    {
        public PolicyRequiredDocumentExtended PolicyRequiredDocument = null;
        public UUID PolicyAssociateId = null;
        public Integer Id = null;
        
        public PolicyRequiredDocumentExtended getPolicyRequiredDocument() { return PolicyRequiredDocument; }
        public PolicyRequiredDocumentRequest setPolicyRequiredDocument(PolicyRequiredDocumentExtended value) { this.PolicyRequiredDocument = value; return this; }
        public UUID getPolicyAssociateId() { return PolicyAssociateId; }
        public PolicyRequiredDocumentRequest setPolicyAssociateId(UUID value) { this.PolicyAssociateId = value; return this; }
        public Integer getId() { return Id; }
        public PolicyRequiredDocumentRequest setId(Integer value) { this.Id = value; return this; }
    }

    public static class PolicyRequiredDocumentExtended extends PolicyRequiredDocument
    {
        public ArrayList<PolicyDocumentReminder> Reminders = new ArrayList<PolicyDocumentReminder>();
        public ArrayList<ReminderExtended> AgentReminders = new ArrayList<ReminderExtended>();
        
        public ArrayList<PolicyDocumentReminder> getReminders() { return Reminders; }
        public PolicyRequiredDocumentExtended setReminders(ArrayList<PolicyDocumentReminder> value) { this.Reminders = value; return this; }
        public ArrayList<ReminderExtended> getAgentReminders() { return AgentReminders; }
        public PolicyRequiredDocumentExtended setAgentReminders(ArrayList<ReminderExtended> value) { this.AgentReminders = value; return this; }
    }

    public static class PolicyRequiredDocument
    {
        public Integer Id = null;
        public UUID PolicyAssociateId = null;
        public Integer PolicyDocumentId = null;
        public Integer NBCStatusId = null;
        public Integer AgentStatusId = null;
        public ArrayList<PolicyDocumentStatus> StatusOptions = new ArrayList<PolicyDocumentStatus>();
        
        public Integer getId() { return Id; }
        public PolicyRequiredDocument setId(Integer value) { this.Id = value; return this; }
        public UUID getPolicyAssociateId() { return PolicyAssociateId; }
        public PolicyRequiredDocument setPolicyAssociateId(UUID value) { this.PolicyAssociateId = value; return this; }
        public Integer getPolicyDocumentId() { return PolicyDocumentId; }
        public PolicyRequiredDocument setPolicyDocumentId(Integer value) { this.PolicyDocumentId = value; return this; }
        public Integer getNbcStatusId() { return NBCStatusId; }
        public PolicyRequiredDocument setNbcStatusId(Integer value) { this.NBCStatusId = value; return this; }
        public Integer getAgentStatusId() { return AgentStatusId; }
        public PolicyRequiredDocument setAgentStatusId(Integer value) { this.AgentStatusId = value; return this; }
        public ArrayList<PolicyDocumentStatus> getStatusOptions() { return StatusOptions; }
        public PolicyRequiredDocument setStatusOptions(ArrayList<PolicyDocumentStatus> value) { this.StatusOptions = value; return this; }
    }

    public static class PolicyDocumentStatus
    {
        public Integer Id = null;
        public String Name = null;
        public Boolean IsNBCStatus = null;
        public Boolean IsAgentStatus = null;
        
        public Integer getId() { return Id; }
        public PolicyDocumentStatus setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public PolicyDocumentStatus setName(String value) { this.Name = value; return this; }
        public Boolean getIsNBCStatus() { return IsNBCStatus; }
        public PolicyDocumentStatus setIsNBCStatus(Boolean value) { this.IsNBCStatus = value; return this; }
        public Boolean getIsAgentStatus() { return IsAgentStatus; }
        public PolicyDocumentStatus setIsAgentStatus(Boolean value) { this.IsAgentStatus = value; return this; }
    }

    public static class PolicyDocumentReminder
    {
        public Integer Id = null;
        public Integer PolicyDocumentId = null;
        public String ReminderFor = null;
        public Integer ReminderLeadTime = null;
        public String ReminderMessage = null;
        public Integer AdminAgentId = null;
        public Boolean NeedsPrompt = null;
        
        public Integer getId() { return Id; }
        public PolicyDocumentReminder setId(Integer value) { this.Id = value; return this; }
        public Integer getPolicyDocumentId() { return PolicyDocumentId; }
        public PolicyDocumentReminder setPolicyDocumentId(Integer value) { this.PolicyDocumentId = value; return this; }
        public String getReminderFor() { return ReminderFor; }
        public PolicyDocumentReminder setReminderFor(String value) { this.ReminderFor = value; return this; }
        public Integer getReminderLeadTime() { return ReminderLeadTime; }
        public PolicyDocumentReminder setReminderLeadTime(Integer value) { this.ReminderLeadTime = value; return this; }
        public String getReminderMessage() { return ReminderMessage; }
        public PolicyDocumentReminder setReminderMessage(String value) { this.ReminderMessage = value; return this; }
        public Integer getAdminAgentId() { return AdminAgentId; }
        public PolicyDocumentReminder setAdminAgentId(Integer value) { this.AdminAgentId = value; return this; }
        public Boolean isNeedsPrompt() { return NeedsPrompt; }
        public PolicyDocumentReminder setNeedsPrompt(Boolean value) { this.NeedsPrompt = value; return this; }
    }

    public static class ReminderExtended extends Reminder
    {
        public String AgentName = null;
        public String RecordAgentName = null;
        public Integer RecordAgentID = null;
        public Boolean IsAdmin = null;
        public Integer AgentID = null;
        
        public String getAgentName() { return AgentName; }
        public ReminderExtended setAgentName(String value) { this.AgentName = value; return this; }
        public String getRecordAgentName() { return RecordAgentName; }
        public ReminderExtended setRecordAgentName(String value) { this.RecordAgentName = value; return this; }
        public Integer getRecordAgentID() { return RecordAgentID; }
        public ReminderExtended setRecordAgentID(Integer value) { this.RecordAgentID = value; return this; }
        public Boolean getIsAdmin() { return IsAdmin; }
        public ReminderExtended setIsAdmin(Boolean value) { this.IsAdmin = value; return this; }
        public Integer getAgentID() { return AgentID; }
        public ReminderExtended setAgentID(Integer value) { this.AgentID = value; return this; }
    }

    public static class Reminder
    {
        public UUID ReminderId = null;
        public String TableName = null;
        public String FieldName = null;
        public Integer RecordId = null;
        public Date ReminderDate = null;
        public String ReminderNote = null;
        public Date CreatedDate = null;
        public String CreatedBy = null;
        public Date CompletedDate = null;
        
        public UUID getReminderId() { return ReminderId; }
        public Reminder setReminderId(UUID value) { this.ReminderId = value; return this; }
        public String getTableName() { return TableName; }
        public Reminder setTableName(String value) { this.TableName = value; return this; }
        public String getFieldName() { return FieldName; }
        public Reminder setFieldName(String value) { this.FieldName = value; return this; }
        public Integer getRecordId() { return RecordId; }
        public Reminder setRecordId(Integer value) { this.RecordId = value; return this; }
        public Date getReminderDate() { return ReminderDate; }
        public Reminder setReminderDate(Date value) { this.ReminderDate = value; return this; }
        public String getReminderNote() { return ReminderNote; }
        public Reminder setReminderNote(String value) { this.ReminderNote = value; return this; }
        public Date getCreatedDate() { return CreatedDate; }
        public Reminder setCreatedDate(Date value) { this.CreatedDate = value; return this; }
        public String getCreatedBy() { return CreatedBy; }
        public Reminder setCreatedBy(String value) { this.CreatedBy = value; return this; }
        public Date getCompletedDate() { return CompletedDate; }
        public Reminder setCompletedDate(Date value) { this.CompletedDate = value; return this; }
    }

    public static class PolicyRequiredDocumentResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<PolicyRequiredDocumentExtended> PolicyRequiredDocuments = new ArrayList<PolicyRequiredDocumentExtended>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public PolicyRequiredDocumentResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<PolicyRequiredDocumentExtended> getPolicyRequiredDocuments() { return PolicyRequiredDocuments; }
        public PolicyRequiredDocumentResponse setPolicyRequiredDocuments(ArrayList<PolicyRequiredDocumentExtended> value) { this.PolicyRequiredDocuments = value; return this; }
    }

}

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