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}
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 .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
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}]}]}