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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentCommunicationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Communications>
    <AgentCommunication>
      <AgentId>0</AgentId>
      <AgentName>String</AgentName>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <IsAgentMessage>false</IsAgentMessage>
      <Message>String</Message>
      <MessageType>String</MessageType>
      <Sender>String</Sender>
      <SubAgentId>0</SubAgentId>
      <SubAgentName>String</SubAgentName>
    </AgentCommunication>
  </Communications>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</AgentCommunicationsResponse>