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}

"use strict";
export class PolicyDocumentStatus {
    /** @param {{Id?:number,Name?:string,IsNBCStatus?:boolean,IsAgentStatus?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Name;
    /** @type {boolean} */
    IsNBCStatus;
    /** @type {boolean} */
    IsAgentStatus;
}
export class PolicyRequiredDocument {
    /** @param {{Id?:number,PolicyAssociateId?:string,PolicyDocumentId?:number,NBCStatusId?:number,AgentStatusId?:number,StatusOptions?:PolicyDocumentStatus[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    PolicyAssociateId;
    /** @type {number} */
    PolicyDocumentId;
    /** @type {number} */
    NBCStatusId;
    /** @type {number} */
    AgentStatusId;
    /** @type {PolicyDocumentStatus[]} */
    StatusOptions = [];
}
export class PolicyDocumentReminder {
    /** @param {{Id?:number,PolicyDocumentId?:number,ReminderFor?:string,ReminderLeadTime?:number,ReminderMessage?:string,AdminAgentId?:number,NeedsPrompt?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    PolicyDocumentId;
    /** @type {string} */
    ReminderFor;
    /** @type {number} */
    ReminderLeadTime;
    /** @type {string} */
    ReminderMessage;
    /** @type {number} */
    AdminAgentId;
    /** @type {boolean} */
    NeedsPrompt;
}
export class Reminder {
    /** @param {{ReminderId?:string,TableName?:string,FieldName?:string,RecordId?:number,ReminderDate?:string,ReminderNote?:string,CreatedDate?:string,CreatedBy?:string,CompletedDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ReminderId;
    /** @type {string} */
    TableName;
    /** @type {string} */
    FieldName;
    /** @type {number} */
    RecordId;
    /** @type {string} */
    ReminderDate;
    /** @type {string} */
    ReminderNote;
    /** @type {string} */
    CreatedDate;
    /** @type {string} */
    CreatedBy;
    /** @type {string} */
    CompletedDate;
}
export class ReminderExtended extends Reminder {
    /** @param {{AgentName?:string,RecordAgentName?:string,RecordAgentID?:number,IsAdmin?:boolean,AgentID?:number,ReminderId?:string,TableName?:string,FieldName?:string,RecordId?:number,ReminderDate?:string,ReminderNote?:string,CreatedDate?:string,CreatedBy?:string,CompletedDate?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    AgentName;
    /** @type {string} */
    RecordAgentName;
    /** @type {number} */
    RecordAgentID;
    /** @type {boolean} */
    IsAdmin;
    /** @type {number} */
    AgentID;
}
export class PolicyRequiredDocumentExtended extends PolicyRequiredDocument {
    /** @param {{Reminders?:PolicyDocumentReminder[],AgentReminders?:ReminderExtended[],Id?:number,PolicyAssociateId?:string,PolicyDocumentId?:number,NBCStatusId?:number,AgentStatusId?:number,StatusOptions?:PolicyDocumentStatus[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {PolicyDocumentReminder[]} */
    Reminders = [];
    /** @type {ReminderExtended[]} */
    AgentReminders = [];
}
export class PolicyRequiredDocumentResponse {
    /** @param {{ResponseStatus?:ResponseStatus,PolicyRequiredDocuments?:PolicyRequiredDocumentExtended[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {PolicyRequiredDocumentExtended[]} */
    PolicyRequiredDocuments = [];
}
export class PolicyRequiredDocumentRequest {
    /** @param {{PolicyRequiredDocument?:PolicyRequiredDocumentExtended,PolicyAssociateId?:string,Id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {PolicyRequiredDocumentExtended} */
    PolicyRequiredDocument;
    /** @type {?string} */
    PolicyAssociateId;
    /** @type {?number} */
    Id;
}

JavaScript 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>