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/16BE-AC64-3B21-4951-BAE9/sites/2aa400ed-8fc8-4357-9dba-4be11a1b1c1a/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": 57,
      "GroupCode": "-822547130",
      "GroupId": "22672fc3-2d27-4be6-bb7b-15af73b80d77",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "2007dbbc-3a94-4f9b-80b4-4920d78e4b26",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 16,
      "GroupCode": "-833108882",
      "GroupId": "55cf14c4-adba-4ba4-8eb0-cb12242ace7c",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "9918df88-7206-4c31-9afa-465272ab30dd",
      "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>57</Endpoints>
      <GroupCode>-822547130</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>22672fc3-2d27-4be6-bb7b-15af73b80d77</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>2007dbbc-3a94-4f9b-80b4-4920d78e4b26</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>16</Endpoints>
      <GroupCode>-833108882</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>55cf14c4-adba-4ba4-8eb0-cb12242ace7c</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>9918df88-7206-4c31-9afa-465272ab30dd</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>