Unity API Documentation

GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/groups

Gets the list of groups on a given GSM site.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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/3783-482C-FD35-4490-8216/sites/15a1c979-8b84-4ea6-943c-89b4ca19c4ae/groups

Body Parameters

None.

Response Information

Resource Description

Information about the list of groups on a given GSM site.

GetGroupsResponseModel
NameDescriptionTypeAdditional 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": 7,
      "GroupCode": "-133412102",
      "GroupId": "469c997d-6560-4f31-bdca-549a763507f7",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "0da0be23-81e1-4867-b875-8216a455531d",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 80,
      "GroupCode": "-290899371",
      "GroupId": "488b6517-ed08-4d20-b1f9-5b900c4335a8",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "8a4ae4e9-3469-4288-9c97-5bf35e73b3c4",
      "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>7</Endpoints>
      <GroupCode>-133412102</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>469c997d-6560-4f31-bdca-549a763507f7</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>0da0be23-81e1-4867-b875-8216a455531d</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>80</Endpoints>
      <GroupCode>-290899371</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>488b6517-ed08-4d20-b1f9-5b900c4335a8</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>8a4ae4e9-3469-4288-9c97-5bf35e73b3c4</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>