| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,PUT,OPTIONS | /v1/Ticket | ||
|---|---|---|---|
| GET | /v1/Ticket/{AgentId}/{Status} |
import Foundation
import ServiceStack
public class TicketRequest : Codable
{
public var ticket:[TicketExtended] = []
public var agentId:Int
public var status:String
required public init(){}
}
public class TicketExtended : Ticket
{
public var agentName:String
public var ticketType:String
public var agentHasRead:Bool
public var adminHasRead:Bool
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case agentName
case ticketType
case agentHasRead
case adminHasRead
}
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)
ticketType = try container.decodeIfPresent(String.self, forKey: .ticketType)
agentHasRead = try container.decodeIfPresent(Bool.self, forKey: .agentHasRead)
adminHasRead = try container.decodeIfPresent(Bool.self, forKey: .adminHasRead)
}
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 ticketType != nil { try container.encode(ticketType, forKey: .ticketType) }
if agentHasRead != nil { try container.encode(agentHasRead, forKey: .agentHasRead) }
if adminHasRead != nil { try container.encode(adminHasRead, forKey: .adminHasRead) }
}
}
public class Ticket : Codable
{
public var ticketId:Int
public var createdDate:Date
public var createdBy:String
public var Description:String
public var resolution:String
public var isClosed:Bool
public var isFollowup:Bool
public var ticketTypeId:Int
public var modifiedDate:Date
public var modifiedBy:String
required public init(){}
}
public class TicketResponse : Codable
{
public var responseStatus:ResponseStatus
public var ticket:[TicketExtended] = []
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/Ticket HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<TicketRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AgentId>0</AgentId>
<Status>String</Status>
<Ticket>
<TicketExtended>
<CreatedBy>00000000-0000-0000-0000-000000000000</CreatedBy>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<Description>String</Description>
<IsClosed>false</IsClosed>
<IsFollowup>false</IsFollowup>
<ModifiedBy>String</ModifiedBy>
<ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
<Resolution>String</Resolution>
<TicketId>0</TicketId>
<TicketTypeId>0</TicketTypeId>
<AdminHasRead>false</AdminHasRead>
<AgentHasRead>false</AgentHasRead>
<AgentName>String</AgentName>
<TicketType>String</TicketType>
</TicketExtended>
</Ticket>
</TicketRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<TicketResponse 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>
<Ticket>
<TicketExtended>
<CreatedBy>00000000-0000-0000-0000-000000000000</CreatedBy>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<Description>String</Description>
<IsClosed>false</IsClosed>
<IsFollowup>false</IsFollowup>
<ModifiedBy>String</ModifiedBy>
<ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
<Resolution>String</Resolution>
<TicketId>0</TicketId>
<TicketTypeId>0</TicketTypeId>
<AdminHasRead>false</AdminHasRead>
<AgentHasRead>false</AgentHasRead>
<AgentName>String</AgentName>
<TicketType>String</TicketType>
</TicketExtended>
</Ticket>
</TicketResponse>