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

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 ChatMemberResponse
{
    public ResponseStatus: ResponseStatus;
    public ChatMember: ChatMember[] = [];

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

export class ChatMemberRequest
{
    public ChatMemberId: string;

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

TypeScript ChatMemberRequest DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ChatMemberRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ChatMemberId>00000000-0000-0000-0000-000000000000</ChatMemberId>
</ChatMemberRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ChatMemberResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ChatMember>
    <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>
  </ChatMember>
  <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>
</ChatMemberResponse>