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

JavaScript AgentCommunicationsRequest 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/Agent/{AgentId}/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: 
	[
		{
			SubAgentId: 0,
			SubAgentName: String,
			AgentId: 0,
			AgentName: String,
			DateCreated: 0001-01-01,
			Message: String,
			MessageType: String,
			IsAgentMessage: False,
			Sender: String
		}
	]
}