Trendsic Platform Service

<back to all web services

CommentRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET/v1/Comment
"use strict";
export class UnreadComment {
    /** @param {{ConversationHeaderId?:string,TableName?:string,FieldName?:string,RecordId?:number,Comment?:string,DateCreated?:string,AgentName?:string,AgentID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ConversationHeaderId;
    /** @type {string} */
    TableName;
    /** @type {string} */
    FieldName;
    /** @type {number} */
    RecordId;
    /** @type {string} */
    Comment;
    /** @type {string} */
    DateCreated;
    /** @type {string} */
    AgentName;
    /** @type {number} */
    AgentID;
}
export class CommentResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Comment?:UnreadComment}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {UnreadComment} */
    Comment;
}
export class CommentRequest {
    /** @param {{ConversationDetailId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ConversationDetailId;
}

JavaScript CommentRequest 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/Comment 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
		}
	},
	Comment: 
	{
		ConversationHeaderId: 00000000000000000000000000000000,
		TableName: String,
		FieldName: String,
		RecordId: 0,
		Comment: String,
		DateCreated: 0001-01-01T00:00:00.0000000+00:00,
		AgentName: String,
		AgentID: 0
	}
}