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}
"use strict";
export class ContactCommunication {
    /** @param {{ContactId?:number,ContactName?:string,AgentId?:number,AgentName?:string,DateCreated?:string,Message?:string,MessageType?:string,IsAgentMessage?:boolean,Sender?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ContactId;
    /** @type {string} */
    ContactName;
    /** @type {number} */
    AgentId;
    /** @type {string} */
    AgentName;
    /** @type {string} */
    DateCreated;
    /** @type {string} */
    Message;
    /** @type {string} */
    MessageType;
    /** @type {boolean} */
    IsAgentMessage;
    /** @type {string} */
    Sender;
}
export class ContactCommunicationsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Communications?:ContactCommunication[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {ContactCommunication[]} */
    Communications = [];
}
export class ContactCommunicationsByHeaderRequest {
    /** @param {{ConversationHeaderId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ConversationHeaderId;
}

JavaScript 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>