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/C3E6-30B7-DA8E-4596-983E/sites/37dd4a53-249e-43a2-b064-fc0315ff062f/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": 37,
      "GroupCode": "-305246749",
      "GroupId": "6a8a5f48-cf5c-448b-9443-ea11908bde5d",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "53b12528-1358-40e2-b0bb-80158aec9cce",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 78,
      "GroupCode": "-297440613",
      "GroupId": "e9f9ddd9-e7e8-4ac0-9ff2-904b11f5b664",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "9b170f11-af33-4d62-b550-612433a8cf69",
      "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>37</Endpoints>
      <GroupCode>-305246749</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>6a8a5f48-cf5c-448b-9443-ea11908bde5d</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>53b12528-1358-40e2-b0bb-80158aec9cce</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>78</Endpoints>
      <GroupCode>-297440613</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>e9f9ddd9-e7e8-4ac0-9ff2-904b11f5b664</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>9b170f11-af33-4d62-b550-612433a8cf69</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>