| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,DELETE,OPTIONS | /v1/Reminder/{ReminderId} | ||
|---|---|---|---|
| POST,PUT,OPTIONS | /v1/Reminder |
import Foundation
import ServiceStack
public class ReminderRequest : Codable
{
public var reminder:[ReminderExtended] = []
public var reminderId:String
public var remindOwner:Bool
public var agentName:String
public var ccavp:Bool
public var isAdminReminder:Bool
public var adminAgentId:Int
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(){}
}
public class ReminderResponse : Codable
{
public var responseStatus:ResponseStatus
public var reminder:[ReminderExtended] = []
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
]
}