| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,OPTIONS | /v1/PolicyDocumentReminder/{PolicyDocumentId} | ||
|---|---|---|---|
| DELETE,OPTIONS | /v1/PolicyDocumentReminder/{Id} | ||
| POST,PUT,OPTIONS | /v1/PolicyDocumentReminder/ |
"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 PolicyDocumentReminderResponse {
/** @param {{ResponseStatus?:ResponseStatus,PolicyDocumentReminder?:PolicyDocumentReminder[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {PolicyDocumentReminder[]} */
PolicyDocumentReminder = [];
}
export class PolicyDocumentReminderRequest {
/** @param {{Id?:number,PolicyDocumentId?:number,Reminder?:PolicyDocumentReminder}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {number} */
PolicyDocumentId;
/** @type {PolicyDocumentReminder} */
Reminder;
}
JavaScript PolicyDocumentReminderRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/PolicyDocumentReminder/ HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
PolicyDocumentId: 0,
Reminder:
{
Id: 0,
PolicyDocumentId: 0,
ReminderFor: String,
ReminderLeadTime: 0,
ReminderMessage: String,
AdminAgentId: 0,
NeedsPrompt: False
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
PolicyDocumentReminder:
[
{
Id: 0,
PolicyDocumentId: 0,
ReminderFor: String,
ReminderLeadTime: 0,
ReminderMessage: String,
AdminAgentId: 0,
NeedsPrompt: False
}
]
}