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}

namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type PolicyDocumentStatus() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val IsNBCStatus:Boolean = new Boolean() with get,set
        member val IsAgentStatus:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type PolicyRequiredDocument() = 
        member val Id:Int32 = new Int32() with get,set
        member val PolicyAssociateId:Guid = new Guid() with get,set
        member val PolicyDocumentId:Int32 = new Int32() with get,set
        member val NBCStatusId:Int32 = new Int32() with get,set
        member val AgentStatusId:Int32 = new Int32() with get,set
        member val StatusOptions:ResizeArray<PolicyDocumentStatus> = new ResizeArray<PolicyDocumentStatus>() with get,set

    [<AllowNullLiteral>]
    type PolicyDocumentReminder() = 
        member val Id:Int32 = new Int32() with get,set
        member val PolicyDocumentId:Int32 = new Int32() with get,set
        member val ReminderFor:String = null with get,set
        member val ReminderLeadTime:Int32 = new Int32() with get,set
        member val ReminderMessage:String = null with get,set
        member val AdminAgentId:Int32 = new Int32() with get,set
        member val NeedsPrompt:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type Reminder() = 
        member val ReminderId:Guid = new Guid() with get,set
        member val TableName:String = null with get,set
        member val FieldName:String = null with get,set
        member val RecordId:Int32 = new Int32() with get,set
        member val ReminderDate:DateTime = new DateTime() with get,set
        member val ReminderNote:String = null with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val CreatedBy:String = null with get,set
        member val CompletedDate:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type ReminderExtended() = 
        inherit Reminder()
        member val AgentName:String = null with get,set
        member val RecordAgentName:String = null with get,set
        member val RecordAgentID:Int32 = new Int32() with get,set
        member val IsAdmin:Boolean = new Boolean() with get,set
        member val AgentID:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type PolicyRequiredDocumentExtended() = 
        inherit PolicyRequiredDocument()
        member val Reminders:ResizeArray<PolicyDocumentReminder> = new ResizeArray<PolicyDocumentReminder>() with get,set
        member val AgentReminders:ResizeArray<ReminderExtended> = new ResizeArray<ReminderExtended>() with get,set

    [<AllowNullLiteral>]
    type PolicyRequiredDocumentResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val PolicyRequiredDocuments:ResizeArray<PolicyRequiredDocumentExtended> = new ResizeArray<PolicyRequiredDocumentExtended>() with get,set

    [<AllowNullLiteral>]
    type PolicyRequiredDocumentRequest() = 
        member val PolicyRequiredDocument:PolicyRequiredDocumentExtended = null with get,set
        member val PolicyAssociateId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Id:Nullable<Int32> = new Nullable<Int32>() with get,set

F# PolicyRequiredDocumentRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<PolicyRequiredDocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Id>0</Id>
  <PolicyAssociateId>00000000-0000-0000-0000-000000000000</PolicyAssociateId>
  <PolicyRequiredDocument>
    <AgentStatusId>0</AgentStatusId>
    <Id>0</Id>
    <NBCStatusId>0</NBCStatusId>
    <PolicyAssociateId>00000000-0000-0000-0000-000000000000</PolicyAssociateId>
    <PolicyDocumentId>0</PolicyDocumentId>
    <StatusOptions>
      <PolicyDocumentStatus>
        <Id>0</Id>
        <IsAgentStatus>false</IsAgentStatus>
        <IsNBCStatus>false</IsNBCStatus>
        <Name>String</Name>
      </PolicyDocumentStatus>
    </StatusOptions>
    <AgentReminders>
      <ReminderExtended>
        <CompletedDate>0001-01-01T00:00:00</CompletedDate>
        <CreatedBy>String</CreatedBy>
        <CreatedDate>0001-01-01T00:00:00</CreatedDate>
        <FieldName>String</FieldName>
        <RecordId>0</RecordId>
        <ReminderDate>0001-01-01T00:00:00</ReminderDate>
        <ReminderId>00000000-0000-0000-0000-000000000000</ReminderId>
        <ReminderNote>String</ReminderNote>
        <TableName>String</TableName>
        <AgentID>0</AgentID>
        <AgentName>String</AgentName>
        <IsAdmin>false</IsAdmin>
        <RecordAgentID>0</RecordAgentID>
        <RecordAgentName>String</RecordAgentName>
      </ReminderExtended>
    </AgentReminders>
    <Reminders>
      <PolicyDocumentReminder>
        <AdminAgentId>0</AdminAgentId>
        <Id>0</Id>
        <NeedsPrompt>false</NeedsPrompt>
        <PolicyDocumentId>0</PolicyDocumentId>
        <ReminderFor>String</ReminderFor>
        <ReminderLeadTime>0</ReminderLeadTime>
        <ReminderMessage>String</ReminderMessage>
      </PolicyDocumentReminder>
    </Reminders>
  </PolicyRequiredDocument>
</PolicyRequiredDocumentRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PolicyRequiredDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <PolicyRequiredDocuments>
    <PolicyRequiredDocumentExtended>
      <AgentStatusId>0</AgentStatusId>
      <Id>0</Id>
      <NBCStatusId>0</NBCStatusId>
      <PolicyAssociateId>00000000-0000-0000-0000-000000000000</PolicyAssociateId>
      <PolicyDocumentId>0</PolicyDocumentId>
      <StatusOptions>
        <PolicyDocumentStatus>
          <Id>0</Id>
          <IsAgentStatus>false</IsAgentStatus>
          <IsNBCStatus>false</IsNBCStatus>
          <Name>String</Name>
        </PolicyDocumentStatus>
      </StatusOptions>
      <AgentReminders>
        <ReminderExtended>
          <CompletedDate>0001-01-01T00:00:00</CompletedDate>
          <CreatedBy>String</CreatedBy>
          <CreatedDate>0001-01-01T00:00:00</CreatedDate>
          <FieldName>String</FieldName>
          <RecordId>0</RecordId>
          <ReminderDate>0001-01-01T00:00:00</ReminderDate>
          <ReminderId>00000000-0000-0000-0000-000000000000</ReminderId>
          <ReminderNote>String</ReminderNote>
          <TableName>String</TableName>
          <AgentID>0</AgentID>
          <AgentName>String</AgentName>
          <IsAdmin>false</IsAdmin>
          <RecordAgentID>0</RecordAgentID>
          <RecordAgentName>String</RecordAgentName>
        </ReminderExtended>
      </AgentReminders>
      <Reminders>
        <PolicyDocumentReminder>
          <AdminAgentId>0</AdminAgentId>
          <Id>0</Id>
          <NeedsPrompt>false</NeedsPrompt>
          <PolicyDocumentId>0</PolicyDocumentId>
          <ReminderFor>String</ReminderFor>
          <ReminderLeadTime>0</ReminderLeadTime>
          <ReminderMessage>String</ReminderMessage>
        </PolicyDocumentReminder>
      </Reminders>
    </PolicyRequiredDocumentExtended>
  </PolicyRequiredDocuments>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</PolicyRequiredDocumentResponse>