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}

**PolicyRequiredDocumentRequest** Parameters:
Name	Parameter	Data Type	Required
PolicyRequiredDocument	body	PolicyRequiredDocumentExtended	No
PolicyAssociateId	path	Guid?	No
Id	path	int?	No

**PolicyRequiredDocumentExtended** Parameters:
Name	Parameter	Data Type	Required	Description
Reminders	form	List<PolicyDocumentReminder>	No
AgentReminders	form	List<ReminderExtended>	No

**PolicyRequiredDocument** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
PolicyAssociateId	form	Guid	No
PolicyDocumentId	form	int	No
NBCStatusId	form	int	No
AgentStatusId	form	int	No
StatusOptions	form	List<PolicyDocumentStatus>	No

**PolicyDocumentStatus** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
IsNBCStatus	form	bool	No
IsAgentStatus	form	bool	No

**PolicyDocumentReminder** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
PolicyDocumentId	form	int	No
ReminderFor	form	string	No
ReminderLeadTime	form	int	No
ReminderMessage	form	string	No
AdminAgentId	form	int	No
NeedsPrompt	form	bool	No

**ReminderExtended** Parameters:
Name	Parameter	Data Type	Required
AgentName	form	string	No
RecordAgentName	form	string	No
RecordAgentID	form	int	No
IsAdmin	form	bool	No
AgentID	form	int	No

**Reminder** Parameters:
Name	Parameter	Data Type	Required
ReminderId	form	Guid	No
TableName	form	string	No
FieldName	form	string	No
RecordId	form	int	No
ReminderDate	form	DateTime	No
ReminderNote	form	string	No
CreatedDate	form	DateTime	No
CreatedBy	form	string	No
CompletedDate	form	DateTime	No

**PolicyRequiredDocumentResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
PolicyRequiredDocuments	form	List<PolicyRequiredDocumentExtended>	No

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