Trendsic Platform Service

<back to all web services

ReminderRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
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 .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/Reminder HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ReminderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AdminAgentId>0</AdminAgentId>
  <AgentName>String</AgentName>
  <CCAVP>false</CCAVP>
  <IsAdminReminder>false</IsAdminReminder>
  <RemindOwner>false</RemindOwner>
  <Reminder>
    <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>
  </Reminder>
  <ReminderId>00000000-0000-0000-0000-000000000000</ReminderId>
</ReminderRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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