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/0EBE-10AC-00DD-4F08-B9D8/sites/52b14d9b-da06-43d1-ab6b-161d37baab85/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": 63,
      "GroupCode": "-301844140",
      "GroupId": "ca38f1b1-76a7-4de7-bc4b-e61d6a0512a5",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "80b40c2e-ce34-421b-83c1-e1b77063fc49",
      "GroupPolicyName": "Test Policy 1"
    },
    {
      "Endpoints": 58,
      "GroupCode": "-391631630",
      "GroupId": "6c9550cd-d18e-4af0-9d73-73aac09c10de",
      "GroupName": "Test Group 2",
      "GroupDescription": "Description of test group 2",
      "GroupPolicyId": "50e1b3f8-ca71-447a-8c77-dae34e30ddf4",
      "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>63</Endpoints>
      <GroupCode>-301844140</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>ca38f1b1-76a7-4de7-bc4b-e61d6a0512a5</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>80b40c2e-ce34-421b-83c1-e1b77063fc49</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
    <GetGroupsResponseModel_Group>
      <Endpoints>58</Endpoints>
      <GroupCode>-391631630</GroupCode>
      <GroupDescription>Description of test group 2</GroupDescription>
      <GroupId>6c9550cd-d18e-4af0-9d73-73aac09c10de</GroupId>
      <GroupName>Test Group 2</GroupName>
      <GroupPolicyId>50e1b3f8-ca71-447a-8c77-dae34e30ddf4</GroupPolicyId>
      <GroupPolicyName>Test Policy 2</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>2</TotalCount>
</GetGroupsResponseModel>