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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Reminder() = 
        member val ReminderId:Guid = new Guid() with get,set
        member val TableName:String = null with get,set
        member val FieldName:String = null with get,set
        member val RecordId:Int32 = new Int32() with get,set
        member val ReminderDate:DateTime = new DateTime() with get,set
        member val ReminderNote:String = null with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val CreatedBy:String = null with get,set
        member val CompletedDate:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type ReminderExtended() = 
        inherit Reminder()
        member val AgentName:String = null with get,set
        member val RecordAgentName:String = null with get,set
        member val RecordAgentID:Int32 = new Int32() with get,set
        member val IsAdmin:Boolean = new Boolean() with get,set
        member val AgentID:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type ReminderResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Reminder:ResizeArray<ReminderExtended> = new ResizeArray<ReminderExtended>() with get,set

    [<AllowNullLiteral>]
    type ReminderRequest() = 
        member val Reminder:ResizeArray<ReminderExtended> = new ResizeArray<ReminderExtended>() with get,set
        member val ReminderId:Guid = new Guid() with get,set
        member val RemindOwner:Boolean = new Boolean() with get,set
        member val AgentName:String = null with get,set
        member val CCAVP:Boolean = new Boolean() with get,set
        member val IsAdminReminder:Boolean = new Boolean() with get,set
        member val AdminAgentId:Int32 = new Int32() with get,set

F# ReminderRequest 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.

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
		}
	]
}