Trendsic Platform Service

<back to all web services

ChatMemberRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator
The following routes are available for this service:
DELETE,OPTIONS/v1/ChatMember/{ChatMemberId}
PUT,OPTIONS/v1/ChatMember/{ChatMemberId}/Archive
"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 ChatMemberResponse {
    /** @param {{ResponseStatus?:ResponseStatus,ChatMember?:ChatMember[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {ChatMember[]} */
    ChatMember = [];
}
export class ChatMemberRequest {
    /** @param {{ChatMemberId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ChatMemberId;
}

JavaScript ChatMemberRequest 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.

PUT /v1/ChatMember/{ChatMemberId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ChatMemberId: 00000000000000000000000000000000
}
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
		}
	},
	ChatMember: 
	[
		{
			ChatMemberId: 00000000000000000000000000000000,
			ChatId: 00000000000000000000000000000000,
			UserId: 00000000000000000000000000000000,
			IsActive: False,
			IsArchived: False,
			LastChatMessageId: 00000000000000000000000000000000,
			ChatMemberName: String
		}
	]
}