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}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class ContactCommunicationsByHeaderRequest
    {
        public UUID ConversationHeaderId = null;
        
        public UUID getConversationHeaderId() { return ConversationHeaderId; }
        public ContactCommunicationsByHeaderRequest setConversationHeaderId(UUID value) { this.ConversationHeaderId = value; return this; }
    }

    public static class ContactCommunicationsResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<ContactCommunication> Communications = new ArrayList<ContactCommunication>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ContactCommunicationsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<ContactCommunication> getCommunications() { return Communications; }
        public ContactCommunicationsResponse setCommunications(ArrayList<ContactCommunication> value) { this.Communications = value; return this; }
    }

    public static class ContactCommunication
    {
        public Integer ContactId = null;
        public String ContactName = null;
        public Integer AgentId = null;
        public String AgentName = null;
        public Date DateCreated = null;
        public String Message = null;
        public String MessageType = null;
        public Boolean IsAgentMessage = null;
        public String Sender = null;
        
        public Integer getContactId() { return ContactId; }
        public ContactCommunication setContactId(Integer value) { this.ContactId = value; return this; }
        public String getContactName() { return ContactName; }
        public ContactCommunication setContactName(String value) { this.ContactName = value; return this; }
        public Integer getAgentId() { return AgentId; }
        public ContactCommunication setAgentId(Integer value) { this.AgentId = value; return this; }
        public String getAgentName() { return AgentName; }
        public ContactCommunication setAgentName(String value) { this.AgentName = value; return this; }
        public Date getDateCreated() { return DateCreated; }
        public ContactCommunication setDateCreated(Date value) { this.DateCreated = value; return this; }
        public String getMessage() { return Message; }
        public ContactCommunication setMessage(String value) { this.Message = value; return this; }
        public String getMessageType() { return MessageType; }
        public ContactCommunication setMessageType(String value) { this.MessageType = value; return this; }
        public Boolean getIsAgentMessage() { return IsAgentMessage; }
        public ContactCommunication setIsAgentMessage(Boolean value) { this.IsAgentMessage = value; return this; }
        public String getSender() { return Sender; }
        public ContactCommunication setSender(String value) { this.Sender = value; return this; }
    }

}

Java ContactCommunicationsByHeaderRequest 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/Communications/{ConversationHeaderId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ContactCommunicationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Communications>
    <ContactCommunication>
      <AgentId>0</AgentId>
      <AgentName>String</AgentName>
      <ContactId>0</ContactId>
      <ContactName>String</ContactName>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <IsAgentMessage>false</IsAgentMessage>
      <Message>String</Message>
      <MessageType>String</MessageType>
      <Sender>String</Sender>
    </ContactCommunication>
  </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>
</ContactCommunicationsResponse>