Trendsic Platform Service

<back to all web services

ConversationRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET/v1/Conversation/{TableName}/{FieldName}/{RecordId}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class ConversationRequest
    {
        public String TableName = null;
        public String FieldName = null;
        public Integer RecordId = null;
        public Boolean ReadFlag = null;
        
        public String getTableName() { return TableName; }
        public ConversationRequest setTableName(String value) { this.TableName = value; return this; }
        public String getFieldName() { return FieldName; }
        public ConversationRequest setFieldName(String value) { this.FieldName = value; return this; }
        public Integer getRecordId() { return RecordId; }
        public ConversationRequest setRecordId(Integer value) { this.RecordId = value; return this; }
        public Boolean isReadFlag() { return ReadFlag; }
        public ConversationRequest setReadFlag(Boolean value) { this.ReadFlag = value; return this; }
    }

    public static class ConversationResponse
    {
        public ResponseStatus ResponseStatus = null;
        public Conversation Conversation = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ConversationResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public Conversation getConversation() { return Conversation; }
        public ConversationResponse setConversation(Conversation value) { this.Conversation = value; return this; }
    }

    public static class Conversation extends ConversationHeader
    {
        public ArrayList<ConversationDetail> Details = new ArrayList<ConversationDetail>();
        
        public ArrayList<ConversationDetail> getDetails() { return Details; }
        public Conversation setDetails(ArrayList<ConversationDetail> value) { this.Details = value; return this; }
    }

    public static class ConversationHeader
    {
        public UUID ConversationHeaderId = null;
        public String TableName = null;
        public String FieldName = null;
        public Integer RecordId = null;
        public Boolean AgentHasRead = null;
        public Boolean AdminHasRead = null;
        
        public UUID getConversationHeaderId() { return ConversationHeaderId; }
        public ConversationHeader setConversationHeaderId(UUID value) { this.ConversationHeaderId = value; return this; }
        public String getTableName() { return TableName; }
        public ConversationHeader setTableName(String value) { this.TableName = value; return this; }
        public String getFieldName() { return FieldName; }
        public ConversationHeader setFieldName(String value) { this.FieldName = value; return this; }
        public Integer getRecordId() { return RecordId; }
        public ConversationHeader setRecordId(Integer value) { this.RecordId = value; return this; }
        public Boolean isAgentHasRead() { return AgentHasRead; }
        public ConversationHeader setAgentHasRead(Boolean value) { this.AgentHasRead = value; return this; }
        public Boolean isAdminHasRead() { return AdminHasRead; }
        public ConversationHeader setAdminHasRead(Boolean value) { this.AdminHasRead = value; return this; }
    }

    public static class ConversationDetail
    {
        public UUID ConversationDetailId = null;
        public UUID ConversationHeaderId = null;
        public String Comment = null;
        public Date DateCreated = null;
        public UUID CreatedBy = null;
        public String CreatedByName = null;
        public UUID AttachmentId = null;
        public Boolean IsAdminComment = null;
        public Boolean IsDeletedComment = null;
        
        public UUID getConversationDetailId() { return ConversationDetailId; }
        public ConversationDetail setConversationDetailId(UUID value) { this.ConversationDetailId = value; return this; }
        public UUID getConversationHeaderId() { return ConversationHeaderId; }
        public ConversationDetail setConversationHeaderId(UUID value) { this.ConversationHeaderId = value; return this; }
        public String getComment() { return Comment; }
        public ConversationDetail setComment(String value) { this.Comment = value; return this; }
        public Date getDateCreated() { return DateCreated; }
        public ConversationDetail setDateCreated(Date value) { this.DateCreated = value; return this; }
        public UUID getCreatedBy() { return CreatedBy; }
        public ConversationDetail setCreatedBy(UUID value) { this.CreatedBy = value; return this; }
        public String getCreatedByName() { return CreatedByName; }
        public ConversationDetail setCreatedByName(String value) { this.CreatedByName = value; return this; }
        public UUID getAttachmentId() { return AttachmentId; }
        public ConversationDetail setAttachmentId(UUID value) { this.AttachmentId = value; return this; }
        public Boolean getIsAdminComment() { return IsAdminComment; }
        public ConversationDetail setIsAdminComment(Boolean value) { this.IsAdminComment = value; return this; }
        public Boolean getIsDeletedComment() { return IsDeletedComment; }
        public ConversationDetail setIsDeletedComment(Boolean value) { this.IsDeletedComment = value; return this; }
    }

}

Java ConversationRequest 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/Conversation/{TableName}/{FieldName}/{RecordId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ConversationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Conversation>
    <AdminHasRead>false</AdminHasRead>
    <AgentHasRead>false</AgentHasRead>
    <ConversationHeaderId>00000000-0000-0000-0000-000000000000</ConversationHeaderId>
    <FieldName>String</FieldName>
    <RecordId>0</RecordId>
    <TableName>String</TableName>
    <Details>
      <ConversationDetail>
        <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
        <Comment>String</Comment>
        <ConversationDetailId>00000000-0000-0000-0000-000000000000</ConversationDetailId>
        <ConversationHeaderId>00000000-0000-0000-0000-000000000000</ConversationHeaderId>
        <CreatedBy>00000000-0000-0000-0000-000000000000</CreatedBy>
        <CreatedByName>String</CreatedByName>
        <DateCreated xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>0001-01-01T00:00:00Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </DateCreated>
        <IsAdminComment>false</IsAdminComment>
        <IsDeletedComment>false</IsDeletedComment>
      </ConversationDetail>
    </Details>
  </Conversation>
  <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>
</ConversationResponse>