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}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class PolicyDocumentReminder
    {
        public virtual int Id { get; set; }
        public virtual int PolicyDocumentId { get; set; }
        public virtual string ReminderFor { get; set; }
        public virtual int ReminderLeadTime { get; set; }
        public virtual string ReminderMessage { get; set; }
        public virtual int AdminAgentId { get; set; }
        public virtual bool NeedsPrompt { get; set; }
    }

    public partial class PolicyDocumentStatus
    {
        public virtual int Id { get; set; }
        public virtual string Name { get; set; }
        public virtual bool IsNBCStatus { get; set; }
        public virtual bool IsAgentStatus { get; set; }
    }

    public partial class PolicyRequiredDocument
    {
        public virtual int Id { get; set; }
        public virtual Guid PolicyAssociateId { get; set; }
        public virtual int PolicyDocumentId { get; set; }
        public virtual int NBCStatusId { get; set; }
        public virtual int AgentStatusId { get; set; }
        public virtual List<PolicyDocumentStatus> StatusOptions { get; set; } = [];
    }

    public partial class PolicyRequiredDocumentExtended
        : PolicyRequiredDocument
    {
        public virtual List<PolicyDocumentReminder> Reminders { get; set; } = [];
        public virtual List<ReminderExtended> AgentReminders { get; set; } = [];
    }

    public partial class PolicyRequiredDocumentRequest
    {
        public virtual PolicyRequiredDocumentExtended PolicyRequiredDocument { get; set; }
        public virtual Guid? PolicyAssociateId { get; set; }
        public virtual int? Id { get; set; }
    }

    public partial class PolicyRequiredDocumentResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<PolicyRequiredDocumentExtended> PolicyRequiredDocuments { get; set; } = [];
    }

    public partial class Reminder
    {
        public virtual Guid ReminderId { get; set; }
        public virtual string TableName { get; set; }
        public virtual string FieldName { get; set; }
        public virtual int RecordId { get; set; }
        public virtual DateTime ReminderDate { get; set; }
        public virtual string ReminderNote { get; set; }
        public virtual DateTime CreatedDate { get; set; }
        public virtual string CreatedBy { get; set; }
        public virtual DateTime CompletedDate { get; set; }
    }

    public partial class ReminderExtended
        : Reminder
    {
        public virtual string AgentName { get; set; }
        public virtual string RecordAgentName { get; set; }
        public virtual int RecordAgentID { get; set; }
        public virtual bool IsAdmin { get; set; }
        public virtual int AgentID { get; set; }
    }

}

C# PolicyRequiredDocumentRequest DTOs

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

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