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

Gets the list of groups on a given GSM site.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

string

Required

siteId

The site identifier.

string

Required

Body Parameters

None.

Response Information

Resource Description

Information about the list of groups on a given GSM site.

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": 2,
  "Groups": [
    {
      "Endpoints": 94,
      "GroupCode": "-614164080",
      "GroupId": "c7b98411-2e0d-4838-b0c5-9323f2b1fa5c",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "59515430-1b34-46c0-b0d4-e7fc5e2fecd7",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 29,
      "GroupCode": "-621183057",
      "GroupId": "5b983ceb-43a2-400c-b17f-7010e6d2059a",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "2c49c115-ae42-4f11-82c5-7a78e92ed8c3",
      "GroupPolicyName": "Test Policy 2"
    }
  ]
}                    
<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>94</Endpoints>
      <GroupCode>-614164080</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>c7b98411-2e0d-4838-b0c5-9323f2b1fa5c</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>59515430-1b34-46c0-b0d4-e7fc5e2fecd7</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>29</Endpoints>
      <GroupCode>-621183057</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>5b983ceb-43a2-400c-b17f-7010e6d2059a</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>2c49c115-ae42-4f11-82c5-7a78e92ed8c3</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>