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/9EC3-A27D-8D9C-41AF-95E7/sites/e2df15cc-336f-4752-8604-c2c40089b2f4/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": 82,
      "GroupCode": "-756240236",
      "GroupId": "37f33d04-edaa-4759-a19f-307d21432533",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "6a80f5b6-1236-43f5-8ccd-83daaa210090",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 16,
      "GroupCode": "-196101918",
      "GroupId": "bad37ae9-e807-4be7-9447-34906c4d3d69",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "dd8ed8a8-0d42-46ca-800d-539c1e4ec1ed",
      "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>82</Endpoints>
      <GroupCode>-756240236</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>37f33d04-edaa-4759-a19f-307d21432533</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>6a80f5b6-1236-43f5-8ccd-83daaa210090</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>16</Endpoints>
      <GroupCode>-196101918</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>bad37ae9-e807-4be7-9447-34906c4d3d69</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>dd8ed8a8-0d42-46ca-800d-539c1e4ec1ed</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>