| Requires any of the roles: | Worker, Agent, Administrator, Worker, Agent, Administrator, Worker, Agent, Administrator, Worker, Agent, Administrator |
| DELETE,OPTIONS | /v1/AgentTask/{TaskId} | ||
|---|---|---|---|
| GET,POST,PUT,OPTIONS | /v1/AgentTask |
import Foundation
import ServiceStack
public class AgentTaskRequest : Codable
{
public var task:AgentTaskExtended
public var taskId:String
required public init(){}
}
public class AgentTaskExtended : AgentTask
{
public var assignedToName:String
public var relatedToName:String
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case assignedToName
case relatedToName
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
assignedToName = try container.decodeIfPresent(String.self, forKey: .assignedToName)
relatedToName = try container.decodeIfPresent(String.self, forKey: .relatedToName)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if assignedToName != nil { try container.encode(assignedToName, forKey: .assignedToName) }
if relatedToName != nil { try container.encode(relatedToName, forKey: .relatedToName) }
}
}
public class AgentTask : Codable
{
public var taskId:String
public var Description:String
public var dueDate:Date
public var assignedToAgentId:Int
public var relatedToAgentId:Int
public var createdBy:Int
public var dateCreated:Date
public var dateCompleted:Date
public var completedBy:Int
public var dateDeleted:Date
public var deletedBy:Int
required public init(){}
}
public class AgentTaskResponse : Codable
{
public var responseStatus:ResponseStatus
public var task:[AgentTaskExtended] = []
required public init(){}
}
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/AgentTask HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<AgentTaskRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Task>
<AssignedToAgentId>0</AssignedToAgentId>
<CompletedBy>0</CompletedBy>
<CreatedBy>0</CreatedBy>
<DateCompleted>0001-01-01T00:00:00</DateCompleted>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateDeleted>0001-01-01T00:00:00</DateDeleted>
<DeletedBy>0</DeletedBy>
<Description>String</Description>
<DueDate>0001-01-01T00:00:00</DueDate>
<RelatedToAgentId>0</RelatedToAgentId>
<TaskId>00000000-0000-0000-0000-000000000000</TaskId>
<AssignedToName>String</AssignedToName>
<RelatedToName>String</RelatedToName>
</Task>
<TaskId>00000000-0000-0000-0000-000000000000</TaskId>
</AgentTaskRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AgentTaskResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<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>
<Task>
<AgentTaskExtended>
<AssignedToAgentId>0</AssignedToAgentId>
<CompletedBy>0</CompletedBy>
<CreatedBy>0</CreatedBy>
<DateCompleted>0001-01-01T00:00:00</DateCompleted>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateDeleted>0001-01-01T00:00:00</DateDeleted>
<DeletedBy>0</DeletedBy>
<Description>String</Description>
<DueDate>0001-01-01T00:00:00</DueDate>
<RelatedToAgentId>0</RelatedToAgentId>
<TaskId>00000000-0000-0000-0000-000000000000</TaskId>
<AssignedToName>String</AssignedToName>
<RelatedToName>String</RelatedToName>
</AgentTaskExtended>
</Task>
</AgentTaskResponse>