Trendsic Platform Service

<back to all web services

ContactCommunicationsRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET/v1/Contact/{ContactId}/Communications
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 ContactCommunicationsRequest implements IConvertible
{
    int? ContactId;

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

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

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

    getTypeName() => "ContactCommunicationsRequest";
    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>[]),
    'ContactCommunicationsRequest': TypeInfo(TypeOf.Class, create:() => ContactCommunicationsRequest()),
});

Dart ContactCommunicationsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/Contact/{ContactId}/Communications HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Communications: 
	[
		{
			ContactId: 0,
			ContactName: String,
			AgentId: 0,
			AgentName: String,
			DateCreated: 0001-01-01,
			Message: String,
			MessageType: String,
			IsAgentMessage: False,
			Sender: String
		}
	]
}