Trendsic Platform Service

<back to all web services

AgentReminderRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/AgentReminder

export class Reminder
{
    public ReminderId: string;
    public TableName: string;
    public FieldName: string;
    public RecordId: number;
    public ReminderDate: string;
    public ReminderNote: string;
    public CreatedDate: string;
    public CreatedBy: string;
    public CompletedDate: string;

    public constructor(init?: Partial<Reminder>) { (Object as any).assign(this, init); }
}

export class ReminderExtended extends Reminder
{
    public AgentName: string;
    public RecordAgentName: string;
    public RecordAgentID: number;
    public IsAdmin: boolean;
    public AgentID: number;

    public constructor(init?: Partial<ReminderExtended>) { super(init); (Object as any).assign(this, init); }
}

export class ReminderResponse
{
    public ResponseStatus: ResponseStatus;
    public Reminder: ReminderExtended[] = [];

    public constructor(init?: Partial<ReminderResponse>) { (Object as any).assign(this, init); }
}

export class AgentReminderRequest
{
    public IsAdmin: boolean;
    public ReminderType: string;

    public constructor(init?: Partial<AgentReminderRequest>) { (Object as any).assign(this, init); }
}

TypeScript AgentReminderRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/AgentReminder HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
		}
	]
}