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}
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 ContactCommunication
            Public Overridable Property ContactId As Integer
            Public Overridable Property ContactName As String
            Public Overridable Property AgentId As Integer
            Public Overridable Property AgentName As String
            Public Overridable Property DateCreated As Date
            Public Overridable Property Message As String
            Public Overridable Property MessageType As String
            Public Overridable Property IsAgentMessage As Boolean
            Public Overridable Property Sender As String
        End Class

        Public Partial Class ContactCommunicationsByHeaderRequest
            Public Overridable Property ConversationHeaderId As Guid
        End Class

        Public Partial Class ContactCommunicationsResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Communications As List(Of ContactCommunication) = New List(Of ContactCommunication)
        End Class
    End Namespace
End Namespace

VB.NET ContactCommunicationsByHeaderRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","Message":"String","MessageType":"String","IsAgentMessage":false,"Sender":"String"}]}