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/B0BE-CDDA-F616-4812-A09D/sites/10c709b3-9541-48eb-8347-2117094bb275/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": 9,
      "GroupCode": "-854226172",
      "GroupId": "e0e906a8-c0b8-4035-88f1-765010f70a91",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "3994a56b-cd15-454d-ab20-1ec4c4c962fd",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 57,
      "GroupCode": "-378617192",
      "GroupId": "942e68f8-f011-4a2d-b2c0-e2f422917d33",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "6a8fa4c7-f9f5-4cda-bbee-38f5a2d8d4a5",
      "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>9</Endpoints>
      <GroupCode>-854226172</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>e0e906a8-c0b8-4035-88f1-765010f70a91</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>3994a56b-cd15-454d-ab20-1ec4c4c962fd</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>57</Endpoints>
      <GroupCode>-378617192</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>942e68f8-f011-4a2d-b2c0-e2f422917d33</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>6a8fa4c7-f9f5-4cda-bbee-38f5a2d8d4a5</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>