Trendsic Platform Service

<back to all web services

ChatRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
PUT,OPTIONS/v1/Chat/{ChatId}
GET,POST,OPTIONS/v1/Chat

export class ChatMember
{
    public ChatMemberId: string;
    public ChatId: string;
    public UserId: string;
    public IsActive: boolean;
    public IsArchived: boolean;
    public LastChatMessageId: string;
    public ChatMemberName: string;

    public constructor(init?: Partial<ChatMember>) { (Object as any).assign(this, init); }
}

export class Chat
{
    public ChatId: string;
    public ChatName: string;
    public CreatedBy: string;
    public DateCreated: string;
    public ChatMembers: ChatMember[] = [];
    public IsArchived: boolean;
    public MemberCount: number;
    public MessageCount: number;
    public UnreadCount: number;
    public CreatedByName: string;

    public constructor(init?: Partial<Chat>) { (Object as any).assign(this, init); }
}

export class ChatResponse
{
    public ResponseStatus: ResponseStatus;
    public Chat: Chat[] = [];

    public constructor(init?: Partial<ChatResponse>) { (Object as any).assign(this, init); }
}

export class ChatRequest
{
    public ChatId: string;
    public Chat: Chat;

    public constructor(init?: Partial<ChatRequest>) { (Object as any).assign(this, init); }
}

TypeScript ChatRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"ChatId":"00000000000000000000000000000000","Chat":{"ChatId":"00000000000000000000000000000000","ChatName":"String","CreatedBy":"00000000000000000000000000000000","DateCreated":"0001-01-01T00:00:00.0000000","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/csv
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-01T00:00:00.0000000","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"}]}