GET api/v3/Chat/GetResponderChatSettings

Returns the data needed to initiate a responder class chat system

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

ChatDataResult object for with the auth token and group info

ChatDataResult
NameDescriptionTypeAdditional information
Token

string

None.

Did

integer

None.

Name

string

None.

Groups

Collection of GroupInfoResultV3

None.

Channels

Collection of ChannelData

None.

Response Formats

application/json

Sample:
{
  "Token": "sample string 1",
  "Did": 2,
  "Name": "sample string 3",
  "Groups": [
    {
      "Gid": 1,
      "Typ": 2,
      "Nme": "sample string 3",
      "Add": "sample string 4"
    },
    {
      "Gid": 1,
      "Typ": 2,
      "Nme": "sample string 3",
      "Add": "sample string 4"
    }
  ],
  "Channels": [
    {
      "Sid": "sample string 1",
      "Name": "sample string 2",
      "MessageCount": 3,
      "MemberCount": 4,
      "LastUpdated": "sample string 5"
    },
    {
      "Sid": "sample string 1",
      "Name": "sample string 2",
      "MessageCount": 3,
      "MemberCount": 4,
      "LastUpdated": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:
<ChatDataResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Chat">
  <Channels>
    <ChannelData>
      <LastUpdated>sample string 5</LastUpdated>
      <MemberCount>4</MemberCount>
      <MessageCount>3</MessageCount>
      <Name>sample string 2</Name>
      <Sid>sample string 1</Sid>
    </ChannelData>
    <ChannelData>
      <LastUpdated>sample string 5</LastUpdated>
      <MemberCount>4</MemberCount>
      <MessageCount>3</MessageCount>
      <Name>sample string 2</Name>
      <Sid>sample string 1</Sid>
    </ChannelData>
  </Channels>
  <Did>2</Did>
  <Groups xmlns:d2p1="http://schemas.datacontract.org/2004/07/Resgrid.Web.Services.Controllers.Version3.Models.Groups">
    <d2p1:GroupInfoResult>
      <d2p1:Add>sample string 4</d2p1:Add>
      <d2p1:Gid>1</d2p1:Gid>
      <d2p1:Nme>sample string 3</d2p1:Nme>
      <d2p1:Typ>2</d2p1:Typ>
    </d2p1:GroupInfoResult>
    <d2p1:GroupInfoResult>
      <d2p1:Add>sample string 4</d2p1:Add>
      <d2p1:Gid>1</d2p1:Gid>
      <d2p1:Nme>sample string 3</d2p1:Nme>
      <d2p1:Typ>2</d2p1:Typ>
    </d2p1:GroupInfoResult>
  </Groups>
  <Name>sample string 3</Name>
  <Token>sample string 1</Token>
</ChatDataResult>