| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| PUT,DELETE,OPTIONS | /v1/PolicyRequiredDocument/{Id} | ||
|---|---|---|---|
| POST,OPTIONS | /v1/PolicyRequiredDocument | ||
| GET | /v1/PolicyRequiredDocument/GetAllByPolicyAssociateId/{PolicyAssociateId} |
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal
Namespace Global
Namespace CRM.AgencyPlatform.API.Internal
Public Partial Class PolicyDocumentReminder
Public Overridable Property Id As Integer
Public Overridable Property PolicyDocumentId As Integer
Public Overridable Property ReminderFor As String
Public Overridable Property ReminderLeadTime As Integer
Public Overridable Property ReminderMessage As String
Public Overridable Property AdminAgentId As Integer
Public Overridable Property NeedsPrompt As Boolean
End Class
Public Partial Class PolicyDocumentStatus
Public Overridable Property Id As Integer
Public Overridable Property Name As String
Public Overridable Property IsNBCStatus As Boolean
Public Overridable Property IsAgentStatus As Boolean
End Class
Public Partial Class PolicyRequiredDocument
Public Overridable Property Id As Integer
Public Overridable Property PolicyAssociateId As Guid
Public Overridable Property PolicyDocumentId As Integer
Public Overridable Property NBCStatusId As Integer
Public Overridable Property AgentStatusId As Integer
Public Overridable Property StatusOptions As List(Of PolicyDocumentStatus) = New List(Of PolicyDocumentStatus)
End Class
Public Partial Class PolicyRequiredDocumentExtended
Inherits PolicyRequiredDocument
Public Overridable Property Reminders As List(Of PolicyDocumentReminder) = New List(Of PolicyDocumentReminder)
Public Overridable Property AgentReminders As List(Of ReminderExtended) = New List(Of ReminderExtended)
End Class
Public Partial Class PolicyRequiredDocumentRequest
Public Overridable Property PolicyRequiredDocument As PolicyRequiredDocumentExtended
Public Overridable Property PolicyAssociateId As Guid?
Public Overridable Property Id As Integer?
End Class
Public Partial Class PolicyRequiredDocumentResponse
Public Overridable Property ResponseStatus As ResponseStatus
Public Overridable Property PolicyRequiredDocuments As List(Of PolicyRequiredDocumentExtended) = New List(Of PolicyRequiredDocumentExtended)
End Class
Public Partial Class Reminder
Public Overridable Property ReminderId As Guid
Public Overridable Property TableName As String
Public Overridable Property FieldName As String
Public Overridable Property RecordId As Integer
Public Overridable Property ReminderDate As Date
Public Overridable Property ReminderNote As String
Public Overridable Property CreatedDate As Date
Public Overridable Property CreatedBy As String
Public Overridable Property CompletedDate As Date
End Class
Public Partial Class ReminderExtended
Inherits Reminder
Public Overridable Property AgentName As String
Public Overridable Property RecordAgentName As String
Public Overridable Property RecordAgentID As Integer
Public Overridable Property IsAdmin As Boolean
Public Overridable Property AgentID As Integer
End Class
End Namespace
End Namespace
VB.NET PolicyRequiredDocumentRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
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-01T00:00:00.0000000","ReminderNote":"String","CreatedDate":"0001-01-01T00:00:00.0000000","CreatedBy":"String","CompletedDate":"0001-01-01T00:00:00.0000000"}],"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/jsonl
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-01T00:00:00.0000000","ReminderNote":"String","CreatedDate":"0001-01-01T00:00:00.0000000","CreatedBy":"String","CompletedDate":"0001-01-01T00:00:00.0000000"}],"Id":0,"PolicyAssociateId":"00000000000000000000000000000000","PolicyDocumentId":0,"NBCStatusId":0,"AgentStatusId":0,"StatusOptions":[{"Id":0,"Name":"String","IsNBCStatus":false,"IsAgentStatus":false}]}]}