Trendsic Platform Service

<back to all web services

AgentCommunicationsRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Agent/{AgentId}/Communications
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type AgentCommunication() = 
        member val SubAgentId:Int32 = new Int32() with get,set
        member val SubAgentName:String = null with get,set
        member val AgentId:Int32 = new Int32() with get,set
        member val AgentName:String = null with get,set
        member val DateCreated:DateTime = new DateTime() with get,set
        member val Message:String = null with get,set
        member val MessageType:String = null with get,set
        member val IsAgentMessage:Boolean = new Boolean() with get,set
        member val Sender:String = null with get,set

    [<AllowNullLiteral>]
    type AgentCommunicationsResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Communications:ResizeArray<AgentCommunication> = new ResizeArray<AgentCommunication>() with get,set

    [<AllowNullLiteral>]
    type AgentCommunicationsRequest() = 
        member val AgentId:Int32 = new Int32() with get,set

F# AgentCommunicationsRequest DTOs

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

HTTP + CSV

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

GET /v1/Agent/{AgentId}/Communications HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Communications":[{"SubAgentId":0,"SubAgentName":"String","AgentId":0,"AgentName":"String","DateCreated":"0001-01-01T00:00:00.0000000","Message":"String","MessageType":"String","IsAgentMessage":false,"Sender":"String"}]}