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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UnreadComment:
    conversation_header_id: Optional[str] = None
    table_name: Optional[str] = None
    field_name: Optional[str] = None
    record_id: int = 0
    comment: Optional[str] = None
    date_created: datetime.datetime = datetime.datetime(1, 1, 1)
    agent_name: Optional[str] = None
    agent_i_d: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CommentResponse:
    response_status: Optional[ResponseStatus] = None
    comment: Optional[UnreadComment] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CommentRequest:
    conversation_detail_id: Optional[str] = None

Python 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
	}
}