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 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class ContactCommunication implements IConvertible
{
    int? ContactId;
    String? ContactName;
    int? AgentId;
    String? AgentName;
    DateTime? DateCreated;
    String? Message;
    String? MessageType;
    bool? IsAgentMessage;
    String? Sender;

    ContactCommunication({this.ContactId,this.ContactName,this.AgentId,this.AgentName,this.DateCreated,this.Message,this.MessageType,this.IsAgentMessage,this.Sender});
    ContactCommunication.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ContactId = json['ContactId'];
        ContactName = json['ContactName'];
        AgentId = json['AgentId'];
        AgentName = json['AgentName'];
        DateCreated = JsonConverters.fromJson(json['DateCreated'],'DateTime',context!);
        Message = json['Message'];
        MessageType = json['MessageType'];
        IsAgentMessage = json['IsAgentMessage'];
        Sender = json['Sender'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ContactId': ContactId,
        'ContactName': ContactName,
        'AgentId': AgentId,
        'AgentName': AgentName,
        'DateCreated': JsonConverters.toJson(DateCreated,'DateTime',context!),
        'Message': Message,
        'MessageType': MessageType,
        'IsAgentMessage': IsAgentMessage,
        'Sender': Sender
    };

    getTypeName() => "ContactCommunication";
    TypeContext? context = _ctx;
}

class ContactCommunicationsResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<ContactCommunication>? Communications = [];

    ContactCommunicationsResponse({this.ResponseStatus,this.Communications});
    ContactCommunicationsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        Communications = JsonConverters.fromJson(json['Communications'],'List<ContactCommunication>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'Communications': JsonConverters.toJson(Communications,'List<ContactCommunication>',context!)
    };

    getTypeName() => "ContactCommunicationsResponse";
    TypeContext? context = _ctx;
}

class ContactCommunicationsByHeaderRequest implements IConvertible
{
    String? ConversationHeaderId;

    ContactCommunicationsByHeaderRequest({this.ConversationHeaderId});
    ContactCommunicationsByHeaderRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ConversationHeaderId = json['ConversationHeaderId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ConversationHeaderId': ConversationHeaderId
    };

    getTypeName() => "ContactCommunicationsByHeaderRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'ContactCommunication': TypeInfo(TypeOf.Class, create:() => ContactCommunication()),
    'ContactCommunicationsResponse': TypeInfo(TypeOf.Class, create:() => ContactCommunicationsResponse()),
    'List<ContactCommunication>': TypeInfo(TypeOf.Class, create:() => <ContactCommunication>[]),
    'ContactCommunicationsByHeaderRequest': TypeInfo(TypeOf.Class, create:() => ContactCommunicationsByHeaderRequest()),
});

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