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/E523-AC8E-C79A-49E5-BA30/sites/732f922f-ac6a-4f6b-b7be-cfb9cc51affe/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": "-991766253",
      "GroupId": "4ef861f7-13e3-4d79-ba87-bf139bf4d906",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "960805da-36d6-4cfb-b320-404a7e7ccaae",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 64,
      "GroupCode": "-535732446",
      "GroupId": "60d92e8a-1963-431b-b1bd-1f1c300f7bf1",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "1a1a5186-4af2-4bed-acd4-4ce3aef38dc4",
      "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>-991766253</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>4ef861f7-13e3-4d79-ba87-bf139bf4d906</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>960805da-36d6-4cfb-b320-404a7e7ccaae</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>64</Endpoints>
      <GroupCode>-535732446</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>60d92e8a-1963-431b-b1bd-1f1c300f7bf1</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>1a1a5186-4af2-4bed-acd4-4ce3aef38dc4</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>