| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator |
| PUT,OPTIONS | /v1/Chat/{ChatId} | ||
|---|---|---|---|
| GET,POST,OPTIONS | /v1/Chat |
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 ChatMember:
chat_member_id: Optional[str] = None
chat_id: Optional[str] = None
user_id: Optional[str] = None
is_active: bool = False
is_archived: bool = False
last_chat_message_id: Optional[str] = None
chat_member_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Chat:
chat_id: Optional[str] = None
chat_name: Optional[str] = None
created_by: Optional[str] = None
date_created: datetime.datetime = datetime.datetime(1, 1, 1)
chat_members: List[ChatMember] = field(default_factory=list)
is_archived: bool = False
member_count: int = 0
message_count: int = 0
unread_count: int = 0
created_by_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ChatResponse:
response_status: Optional[ResponseStatus] = None
chat: List[Chat] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ChatRequest:
chat_id: Optional[str] = None
chat: Optional[Chat] = None
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.
POST /v1/Chat HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ChatId: 00000000000000000000000000000000,
Chat:
{
ChatId: 00000000000000000000000000000000,
ChatName: String,
CreatedBy: 00000000000000000000000000000000,
DateCreated: 0001-01-01,
ChatMembers:
[
{
ChatMemberId: 00000000000000000000000000000000,
ChatId: 00000000000000000000000000000000,
UserId: 00000000000000000000000000000000,
IsActive: False,
IsArchived: False,
LastChatMessageId: 00000000000000000000000000000000,
ChatMemberName: String
}
],
IsArchived: False,
MemberCount: 0,
MessageCount: 0,
UnreadCount: 0,
CreatedByName: String
}
}
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
}
},
Chat:
[
{
ChatId: 00000000000000000000000000000000,
ChatName: String,
CreatedBy: 00000000000000000000000000000000,
DateCreated: 0001-01-01,
ChatMembers:
[
{
ChatMemberId: 00000000000000000000000000000000,
ChatId: 00000000000000000000000000000000,
UserId: 00000000000000000000000000000000,
IsActive: False,
IsArchived: False,
LastChatMessageId: 00000000000000000000000000000000,
ChatMemberName: String
}
],
IsArchived: False,
MemberCount: 0,
MessageCount: 0,
UnreadCount: 0,
CreatedByName: String
}
]
}