| Requires any of the roles: | Agent, Administrator |
| GET | /v1/Conversation/{TableName}/{FieldName}/{RecordId} |
|---|
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 ConversationHeader:
conversation_header_id: Optional[str] = None
table_name: Optional[str] = None
field_name: Optional[str] = None
record_id: int = 0
agent_has_read: bool = False
admin_has_read: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ConversationDetail:
conversation_detail_id: Optional[str] = None
conversation_header_id: Optional[str] = None
comment: Optional[str] = None
date_created: datetime.datetime = datetime.datetime(1, 1, 1)
created_by: Optional[str] = None
created_by_name: Optional[str] = None
attachment_id: Optional[str] = None
is_admin_comment: bool = False
is_deleted_comment: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Conversation(ConversationHeader):
details: List[ConversationDetail] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ConversationResponse:
response_status: Optional[ResponseStatus] = None
conversation: Optional[Conversation] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ConversationRequest:
table_name: Optional[str] = None
field_name: Optional[str] = None
record_id: int = 0
read_flag: bool = False
Python ConversationRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/Conversation/{TableName}/{FieldName}/{RecordId} 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
}
},
Conversation:
{
Details:
[
{
ConversationDetailId: 00000000000000000000000000000000,
ConversationHeaderId: 00000000000000000000000000000000,
Comment: String,
DateCreated: 0001-01-01T00:00:00.0000000+00:00,
CreatedBy: 00000000000000000000000000000000,
CreatedByName: String,
AttachmentId: 00000000000000000000000000000000,
IsAdminComment: False,
IsDeletedComment: False
}
],
ConversationHeaderId: 00000000000000000000000000000000,
TableName: String,
FieldName: String,
RecordId: 0,
AgentHasRead: False,
AdminHasRead: False
}
}