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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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: application/json
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}]}]}