Trendsic Platform Service

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}


export class PolicyDocumentStatus
{
    public Id: number;
    public Name: string;
    public IsNBCStatus: boolean;
    public IsAgentStatus: boolean;

    public constructor(init?: Partial<PolicyDocumentStatus>) { (Object as any).assign(this, init); }
}

export class PolicyRequiredDocument
{
    public Id: number;
    public PolicyAssociateId: string;
    public PolicyDocumentId: number;
    public NBCStatusId: number;
    public AgentStatusId: number;
    public StatusOptions: PolicyDocumentStatus[] = [];

    public constructor(init?: Partial<PolicyRequiredDocument>) { (Object as any).assign(this, init); }
}

export class PolicyDocumentReminder
{
    public Id: number;
    public PolicyDocumentId: number;
    public ReminderFor: string;
    public ReminderLeadTime: number;
    public ReminderMessage: string;
    public AdminAgentId: number;
    public NeedsPrompt: boolean;

    public constructor(init?: Partial<PolicyDocumentReminder>) { (Object as any).assign(this, init); }
}

export class Reminder
{
    public ReminderId: string;
    public TableName: string;
    public FieldName: string;
    public RecordId: number;
    public ReminderDate: string;
    public ReminderNote: string;
    public CreatedDate: string;
    public CreatedBy: string;
    public CompletedDate: string;

    public constructor(init?: Partial<Reminder>) { (Object as any).assign(this, init); }
}

export class ReminderExtended extends Reminder
{
    public AgentName: string;
    public RecordAgentName: string;
    public RecordAgentID: number;
    public IsAdmin: boolean;
    public AgentID: number;

    public constructor(init?: Partial<ReminderExtended>) { super(init); (Object as any).assign(this, init); }
}

export class PolicyRequiredDocumentExtended extends PolicyRequiredDocument
{
    public Reminders: PolicyDocumentReminder[] = [];
    public AgentReminders: ReminderExtended[] = [];

    public constructor(init?: Partial<PolicyRequiredDocumentExtended>) { super(init); (Object as any).assign(this, init); }
}

export class PolicyRequiredDocumentResponse
{
    public ResponseStatus: ResponseStatus;
    public PolicyRequiredDocuments: PolicyRequiredDocumentExtended[] = [];

    public constructor(init?: Partial<PolicyRequiredDocumentResponse>) { (Object as any).assign(this, init); }
}

export class PolicyRequiredDocumentRequest
{
    public PolicyRequiredDocument: PolicyRequiredDocumentExtended;
    public PolicyAssociateId?: string;
    public Id?: number;

    public constructor(init?: Partial<PolicyRequiredDocumentRequest>) { (Object as any).assign(this, init); }
}

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