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

Gets the list of groups on a given GSM site.

Request Information

URI Parameters

Name	Description	Type	Additional 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/4343-BA67-376A-4DDE-8F36/sites/dad77b3b-1b8f-4fa2-bf5f-ce183dc0a00a/groups

Body Parameters

None.

Response Information

Resource Description

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

GetGroupsResponseModel

Name	Description	Type	Additional 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": 32,
      "GroupCode": "-530438432",
      "GroupId": "266aa06c-934e-4dd1-8df5-46217377efe6",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "d375317a-d185-49b7-8ccc-eda1f9abce04",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 35,
      "GroupCode": "-881032386",
      "GroupId": "5876c81d-6132-4d27-99b8-01c362ec1930",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "3ecc3aae-7b01-489c-8c36-7411127fd1d1",
      "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>32</Endpoints>
      <GroupCode>-530438432</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>266aa06c-934e-4dd1-8df5-46217377efe6</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>d375317a-d185-49b7-8ccc-eda1f9abce04</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>35</Endpoints>
      <GroupCode>-881032386</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>5876c81d-6132-4d27-99b8-01c362ec1930</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>3ecc3aae-7b01-489c-8c36-7411127fd1d1</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>