Trendsic Platform Service

<back to all web services

ProcessRemindersRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/ProcessReminders/{PolicyRequiredDocumentId}
"use strict";
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 ProcessRemindersRequest {
    /** @param {{PolicyRequiredDocumentId?:number,Reminders?:PolicyDocumentReminder[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    PolicyRequiredDocumentId;
    /** @type {PolicyDocumentReminder[]} */
    Reminders = [];
}

JavaScript ProcessRemindersRequest 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/ProcessReminders/{PolicyRequiredDocumentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ProcessRemindersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <PolicyRequiredDocumentId>0</PolicyRequiredDocumentId>
  <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>
</ProcessRemindersRequest>