| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,DELETE,OPTIONS | /v1/Reminder/{ReminderId} | ||
|---|---|---|---|
| POST,PUT,OPTIONS | /v1/Reminder |
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 ReminderRequest
{
public Reminder: ReminderExtended[] = [];
public ReminderId: string;
public RemindOwner: boolean;
public AgentName: string;
public CCAVP: boolean;
public IsAdminReminder: boolean;
public AdminAgentId: number;
public constructor(init?: Partial<ReminderRequest>) { (Object as any).assign(this, init); }
}
TypeScript ReminderRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>