Trendsic Platform Service

<back to all web services

AgentCommunicationsRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Agent/{AgentId}/Communications
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class AgentCommunication implements IConvertible
{
    int? SubAgentId;
    String? SubAgentName;
    int? AgentId;
    String? AgentName;
    DateTime? DateCreated;
    String? Message;
    String? MessageType;
    bool? IsAgentMessage;
    String? Sender;

    AgentCommunication({this.SubAgentId,this.SubAgentName,this.AgentId,this.AgentName,this.DateCreated,this.Message,this.MessageType,this.IsAgentMessage,this.Sender});
    AgentCommunication.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SubAgentId = json['SubAgentId'];
        SubAgentName = json['SubAgentName'];
        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() => {
        'SubAgentId': SubAgentId,
        'SubAgentName': SubAgentName,
        'AgentId': AgentId,
        'AgentName': AgentName,
        'DateCreated': JsonConverters.toJson(DateCreated,'DateTime',context!),
        'Message': Message,
        'MessageType': MessageType,
        'IsAgentMessage': IsAgentMessage,
        'Sender': Sender
    };

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

class AgentCommunicationsResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<AgentCommunication>? Communications = [];

    AgentCommunicationsResponse({this.ResponseStatus,this.Communications});
    AgentCommunicationsResponse.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<AgentCommunication>',context!);
        return this;
    }

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

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

class AgentCommunicationsRequest implements IConvertible
{
    int? AgentId;

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

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

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

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

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

Dart AgentCommunicationsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /v1/Agent/{AgentId}/Communications HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Communications":[{"SubAgentId":0,"SubAgentName":"String","AgentId":0,"AgentName":"String","DateCreated":"0001-01-01T00:00:00.0000000","Message":"String","MessageType":"String","IsAgentMessage":false,"Sender":"String"}]}