| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/AgentReminder |
|---|
import Foundation
import ServiceStack
public class AgentReminderRequest : Codable
{
public var isAdmin:Bool
public var reminderType:String
required public init(){}
}
public class ReminderResponse : Codable
{
public var responseStatus:ResponseStatus
public var reminder:[ReminderExtended] = []
required public init(){}
}
public class ReminderExtended : Reminder
{
public var agentName:String
public var recordAgentName:String
public var recordAgentID:Int
public var isAdmin:Bool
public var agentID:Int
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case agentName
case recordAgentName
case recordAgentID
case isAdmin
case agentID
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
agentName = try container.decodeIfPresent(String.self, forKey: .agentName)
recordAgentName = try container.decodeIfPresent(String.self, forKey: .recordAgentName)
recordAgentID = try container.decodeIfPresent(Int.self, forKey: .recordAgentID)
isAdmin = try container.decodeIfPresent(Bool.self, forKey: .isAdmin)
agentID = try container.decodeIfPresent(Int.self, forKey: .agentID)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if agentName != nil { try container.encode(agentName, forKey: .agentName) }
if recordAgentName != nil { try container.encode(recordAgentName, forKey: .recordAgentName) }
if recordAgentID != nil { try container.encode(recordAgentID, forKey: .recordAgentID) }
if isAdmin != nil { try container.encode(isAdmin, forKey: .isAdmin) }
if agentID != nil { try container.encode(agentID, forKey: .agentID) }
}
}
public class Reminder : Codable
{
public var reminderId:String
public var tableName:String
public var fieldName:String
public var recordId:Int
public var reminderDate:Date
public var reminderNote:String
public var createdDate:Date
public var createdBy:String
public var completedDate:Date
required public init(){}
}
Swift AgentReminderRequest 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.
GET /v1/AgentReminder HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: application/xml
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>