Trendsic Platform Service

<back to all web services

ConversationByHeaderRequest

Requires Authentication
The following routes are available for this service:
GET/v1/ConversationByHeader/{HeaderId}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class Conversation
            Inherits ConversationHeader
            Public Overridable Property Details As List(Of ConversationDetail) = New List(Of ConversationDetail)
        End Class

        Public Partial Class ConversationByHeaderRequest
            Public Overridable Property HeaderId As Guid
        End Class

        Public Partial Class ConversationDetail
            Public Overridable Property ConversationDetailId As Guid
            Public Overridable Property ConversationHeaderId As Guid
            Public Overridable Property Comment As String
            Public Overridable Property DateCreated As DateTimeOffset
            Public Overridable Property CreatedBy As Guid
            Public Overridable Property CreatedByName As String
            Public Overridable Property AttachmentId As Guid
            Public Overridable Property IsAdminComment As Boolean
            Public Overridable Property IsDeletedComment As Boolean
        End Class

        Public Partial Class ConversationHeader
            Public Overridable Property ConversationHeaderId As Guid
            Public Overridable Property TableName As String
            Public Overridable Property FieldName As String
            Public Overridable Property RecordId As Integer
            Public Overridable Property AgentHasRead As Boolean
            Public Overridable Property AdminHasRead As Boolean
        End Class

        Public Partial Class ConversationResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Conversation As Conversation
        End Class
    End Namespace
End Namespace

VB.NET ConversationByHeaderRequest 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/ConversationByHeader/{HeaderId} 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
	}
}