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
api/console/gsm/5F00-E88E-0D8D-449C-9005/sites/bd958ce0-2d2e-4cad-aad0-131b39b31b4f/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": 50,
      "GroupCode": "-643374373",
      "GroupId": "6a757dd6-815d-444f-a7a0-646919ee7d7e",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "f53d6668-15fa-4d6c-8277-f8fa2789f514",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 15,
      "GroupCode": "-214684411",
      "GroupId": "4e79696f-1e86-4d12-8ffd-7f31d2198f69",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "7e7ddccc-6ab6-4efe-aeeb-3acc614adf05",
      "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>50</Endpoints>
      <GroupCode>-643374373</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>6a757dd6-815d-444f-a7a0-646919ee7d7e</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>f53d6668-15fa-4d6c-8277-f8fa2789f514</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>15</Endpoints>
      <GroupCode>-214684411</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>4e79696f-1e86-4d12-8ffd-7f31d2198f69</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>7e7ddccc-6ab6-4efe-aeeb-3acc614adf05</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>