GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/groups/{groupId}

Gets information about a group.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

string

Required

siteId

The site identifier.

string

Required

groupId

The group identifier.

string

Required

Body Parameters

None.

Response Information

Resource Description

Information about the desired group.

GetGroupsResponseModel
NameDescriptionTypeAdditional Information
TotalCount

Total number of groups available.

integer

None.

Groups

List of group details records.

Collection of GetGroupsResponseModel_Group

None.

Sample Response

{
  "TotalCount": 1,
  "Groups": [
    {
      "Endpoints": 99,
      "GroupCode": "-959918869",
      "GroupId": "a629f941-843c-4956-b353-756f7e36b8d8",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "8bca2322-1b0f-4cc5-86f7-c1d1ff2268fd",
      "GroupPolicyName": "Test Policy 1"
    }
  ]
}                    
<GetGroupsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <Groups>
    <GetGroupsResponseModel_Group>
      <Endpoints>99</Endpoints>
      <GroupCode>-959918869</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>a629f941-843c-4956-b353-756f7e36b8d8</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>8bca2322-1b0f-4cc5-86f7-c1d1ff2268fd</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>1</TotalCount>
</GetGroupsResponseModel>