| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,DELETE,OPTIONS | /v1/Reminder/{ReminderId} | ||
|---|---|---|---|
| POST,PUT,OPTIONS | /v1/Reminder |
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal
Namespace Global
Namespace CRM.AgencyPlatform.API.Internal
Public Partial Class Reminder
Public Overridable Property ReminderId As Guid
Public Overridable Property TableName As String
Public Overridable Property FieldName As String
Public Overridable Property RecordId As Integer
Public Overridable Property ReminderDate As Date
Public Overridable Property ReminderNote As String
Public Overridable Property CreatedDate As Date
Public Overridable Property CreatedBy As String
Public Overridable Property CompletedDate As Date
End Class
Public Partial Class ReminderExtended
Inherits Reminder
Public Overridable Property AgentName As String
Public Overridable Property RecordAgentName As String
Public Overridable Property RecordAgentID As Integer
Public Overridable Property IsAdmin As Boolean
Public Overridable Property AgentID As Integer
End Class
Public Partial Class ReminderRequest
Public Overridable Property Reminder As List(Of ReminderExtended) = New List(Of ReminderExtended)
Public Overridable Property ReminderId As Guid
Public Overridable Property RemindOwner As Boolean
Public Overridable Property AgentName As String
Public Overridable Property CCAVP As Boolean
Public Overridable Property IsAdminReminder As Boolean
Public Overridable Property AdminAgentId As Integer
End Class
Public Partial Class ReminderResponse
Public Overridable Property ResponseStatus As ResponseStatus
Public Overridable Property Reminder As List(Of ReminderExtended) = New List(Of ReminderExtended)
End Class
End Namespace
End Namespace
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>