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

URI Sample(s)

GET
https://unityapi.webrootcloudav.com/service/api/console/gsm/BED3-5C44-2025-40EA-97FA/sites/0a6d533a-65a7-486b-bfa5-ed7aa8eb443e/groups

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": 10,
      "GroupCode": "-769779517",
      "GroupId": "c474420c-7548-40d1-bae5-30e6cd5a1acb",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "6a31c7e7-3e5a-4805-a9f2-16653013b427",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 6,
      "GroupCode": "-523552900",
      "GroupId": "74af918f-ae4c-41e0-9a73-0e2ad20294af",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "e27de34c-ba42-403b-b387-862ed1f59180",
      "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>10</Endpoints>
      <GroupCode>-769779517</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>c474420c-7548-40d1-bae5-30e6cd5a1acb</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>6a31c7e7-3e5a-4805-a9f2-16653013b427</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>6</Endpoints>
      <GroupCode>-523552900</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>74af918f-ae4c-41e0-9a73-0e2ad20294af</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>e27de34c-ba42-403b-b387-862ed1f59180</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>