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}
ConversationRequest Parameters:
NameParameterData TypeRequiredDescription
TableNamepathstringNo
FieldNamepathstringNo
RecordIdpathintNo
ReadFlagqueryboolNo
ConversationResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ConversationformConversationNo
Conversation Parameters:
NameParameterData TypeRequiredDescription
DetailsformList<ConversationDetail>No
ConversationHeader Parameters:
NameParameterData TypeRequiredDescription
ConversationHeaderIdformGuidNo
TableNameformstringNo
FieldNameformstringNo
RecordIdformintNo
AgentHasReadformboolNo
AdminHasReadformboolNo
ConversationDetail Parameters:
NameParameterData TypeRequiredDescription
ConversationDetailIdformGuidNo
ConversationHeaderIdformGuidNo
CommentformstringNo
DateCreatedformDateTimeOffsetNo
CreatedByformGuidNo
CreatedByNameformstringNo
AttachmentIdformGuidNo
IsAdminCommentformboolNo
IsDeletedCommentformboolNo

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
	}
}