| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,DELETE,OPTIONS | /v1/Reminder/{ReminderId} | ||
|---|---|---|---|
| POST,PUT,OPTIONS | /v1/Reminder |
"use strict";
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 ReminderResponse {
/** @param {{ResponseStatus?:ResponseStatus,Reminder?:ReminderExtended[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {ReminderExtended[]} */
Reminder = [];
}
export class ReminderRequest {
/** @param {{Reminder?:ReminderExtended[],ReminderId?:string,RemindOwner?:boolean,AgentName?:string,CCAVP?:boolean,IsAdminReminder?:boolean,AdminAgentId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ReminderExtended[]} */
Reminder = [];
/** @type {string} */
ReminderId;
/** @type {boolean} */
RemindOwner;
/** @type {string} */
AgentName;
/** @type {boolean} */
CCAVP;
/** @type {boolean} */
IsAdminReminder;
/** @type {number} */
AdminAgentId;
}
JavaScript ReminderRequest 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/Reminder HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Reminder:
[
{
AgentName: String,
RecordAgentName: String,
RecordAgentID: 0,
IsAdmin: False,
AgentID: 0,
ReminderId: 00000000000000000000000000000000,
TableName: String,
FieldName: String,
RecordId: 0,
ReminderDate: 0001-01-01,
ReminderNote: String,
CreatedDate: 0001-01-01,
CreatedBy: String,
CompletedDate: 0001-01-01
}
],
ReminderId: 00000000000000000000000000000000,
RemindOwner: False,
AgentName: String,
CCAVP: False,
IsAdminReminder: False,
AdminAgentId: 0
}
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
}
},
Reminder:
[
{
AgentName: String,
RecordAgentName: String,
RecordAgentID: 0,
IsAdmin: False,
AgentID: 0,
ReminderId: 00000000000000000000000000000000,
TableName: String,
FieldName: String,
RecordId: 0,
ReminderDate: 0001-01-01,
ReminderNote: String,
CreatedDate: 0001-01-01,
CreatedBy: String,
CompletedDate: 0001-01-01
}
]
}