| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator |
| PUT,OPTIONS | /v1/Chat/{ChatId} | ||
|---|---|---|---|
| GET,POST,OPTIONS | /v1/Chat |
"use strict";
export class ChatMember {
/** @param {{ChatMemberId?:string,ChatId?:string,UserId?:string,IsActive?:boolean,IsArchived?:boolean,LastChatMessageId?:string,ChatMemberName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ChatMemberId;
/** @type {string} */
ChatId;
/** @type {string} */
UserId;
/** @type {boolean} */
IsActive;
/** @type {boolean} */
IsArchived;
/** @type {string} */
LastChatMessageId;
/** @type {string} */
ChatMemberName;
}
export class Chat {
/** @param {{ChatId?:string,ChatName?:string,CreatedBy?:string,DateCreated?:string,ChatMembers?:ChatMember[],IsArchived?:boolean,MemberCount?:number,MessageCount?:number,UnreadCount?:number,CreatedByName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ChatId;
/** @type {string} */
ChatName;
/** @type {string} */
CreatedBy;
/** @type {string} */
DateCreated;
/** @type {ChatMember[]} */
ChatMembers = [];
/** @type {boolean} */
IsArchived;
/** @type {number} */
MemberCount;
/** @type {number} */
MessageCount;
/** @type {number} */
UnreadCount;
/** @type {string} */
CreatedByName;
}
export class ChatResponse {
/** @param {{ResponseStatus?:ResponseStatus,Chat?:Chat[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {Chat[]} */
Chat = [];
}
export class ChatRequest {
/** @param {{ChatId?:string,Chat?:Chat}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ChatId;
/** @type {Chat} */
Chat;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<ChatRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Chat>
<ChatId>00000000-0000-0000-0000-000000000000</ChatId>
<ChatMembers>
<ChatMember>
<ChatId>00000000-0000-0000-0000-000000000000</ChatId>
<ChatMemberId>00000000-0000-0000-0000-000000000000</ChatMemberId>
<ChatMemberName>String</ChatMemberName>
<IsActive>false</IsActive>
<IsArchived>false</IsArchived>
<LastChatMessageId>00000000-0000-0000-0000-000000000000</LastChatMessageId>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
</ChatMember>
</ChatMembers>
<ChatName>String</ChatName>
<CreatedBy>00000000-0000-0000-0000-000000000000</CreatedBy>
<CreatedByName>String</CreatedByName>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<IsArchived>false</IsArchived>
<MemberCount>0</MemberCount>
<MessageCount>0</MessageCount>
<UnreadCount>0</UnreadCount>
</Chat>
<ChatId>00000000-0000-0000-0000-000000000000</ChatId>
</ChatRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ChatResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Chat>
<Chat>
<ChatId>00000000-0000-0000-0000-000000000000</ChatId>
<ChatMembers>
<ChatMember>
<ChatId>00000000-0000-0000-0000-000000000000</ChatId>
<ChatMemberId>00000000-0000-0000-0000-000000000000</ChatMemberId>
<ChatMemberName>String</ChatMemberName>
<IsActive>false</IsActive>
<IsArchived>false</IsArchived>
<LastChatMessageId>00000000-0000-0000-0000-000000000000</LastChatMessageId>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
</ChatMember>
</ChatMembers>
<ChatName>String</ChatName>
<CreatedBy>00000000-0000-0000-0000-000000000000</CreatedBy>
<CreatedByName>String</CreatedByName>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<IsArchived>false</IsArchived>
<MemberCount>0</MemberCount>
<MessageCount>0</MessageCount>
<UnreadCount>0</UnreadCount>
</Chat>
</Chat>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</ChatResponse>