Trendsic Platform Service

<back to all web services

ContactCommunicationsByHeaderRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET/v1/Communications/{ConversationHeaderId}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class ContactCommunicationsByHeaderRequest
{
    open var ConversationHeaderId:UUID? = null
}

open class ContactCommunicationsResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Communications:ArrayList<ContactCommunication> = ArrayList<ContactCommunication>()
}

open class ContactCommunication
{
    open var ContactId:Int? = null
    open var ContactName:String? = null
    open var AgentId:Int? = null
    open var AgentName:String? = null
    open var DateCreated:Date? = null
    open var Message:String? = null
    open var MessageType:String? = null
    open var IsAgentMessage:Boolean? = null
    open var Sender:String? = null
}

Kotlin ContactCommunicationsByHeaderRequest 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/Communications/{ConversationHeaderId} 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
		}
	},
	Communications: 
	[
		{
			ContactId: 0,
			ContactName: String,
			AgentId: 0,
			AgentName: String,
			DateCreated: 0001-01-01,
			Message: String,
			MessageType: String,
			IsAgentMessage: False,
			Sender: String
		}
	]
}