Trendsic Platform Service

<back to all web services

ConversationRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET/v1/Conversation/{TableName}/{FieldName}/{RecordId}
import Foundation
import ServiceStack

public class ConversationRequest : Codable
{
    public var tableName:String
    public var fieldName:String
    public var recordId:Int
    public var readFlag:Bool

    required public init(){}
}

public class ConversationResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var conversation:Conversation

    required public init(){}
}

public class Conversation : ConversationHeader
{
    public var details:[ConversationDetail] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case details
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        details = try container.decodeIfPresent([ConversationDetail].self, forKey: .details) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if details.count > 0 { try container.encode(details, forKey: .details) }
    }
}

public class ConversationHeader : Codable
{
    public var conversationHeaderId:String
    public var tableName:String
    public var fieldName:String
    public var recordId:Int
    public var agentHasRead:Bool
    public var adminHasRead:Bool

    required public init(){}
}

public class ConversationDetail : Codable
{
    public var conversationDetailId:String
    public var conversationHeaderId:String
    public var comment:String
    public var dateCreated:Date
    public var createdBy:String
    public var createdByName:String
    public var attachmentId:String
    public var isAdminComment:Bool
    public var isDeletedComment:Bool

    required public init(){}
}


Swift ConversationRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/Conversation/{TableName}/{FieldName}/{RecordId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
		}
	},
	Conversation: 
	{
		Details: 
		[
			{
				ConversationDetailId: 00000000000000000000000000000000,
				ConversationHeaderId: 00000000000000000000000000000000,
				Comment: String,
				DateCreated: 0001-01-01T00:00:00.0000000+00:00,
				CreatedBy: 00000000000000000000000000000000,
				CreatedByName: String,
				AttachmentId: 00000000000000000000000000000000,
				IsAdminComment: False,
				IsDeletedComment: False
			}
		],
		ConversationHeaderId: 00000000000000000000000000000000,
		TableName: String,
		FieldName: String,
		RecordId: 0,
		AgentHasRead: False,
		AdminHasRead: False
	}
}