Documentation

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

Gets information about a group.

Request Information

URI Parameters

Name	Description	Type	Additional Information
gsmKey	The GSM console keycode.	string	Required
siteId	The site identifier.	string	Required
groupId	The group identifier.	string	Required

Body Parameters

None.

Response Information

Resource Description

Information about the desired group.

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.

{
  "TotalCount": 1,
  "Groups": [
    {
      "Endpoints": 46,
      "GroupCode": "-242298043",
      "GroupId": "6289968a-dc91-4228-9140-066b8b8c18b1",
      "GroupName": "Test Group 1",
      "GroupDescription": "Description of test group 1",
      "GroupPolicyId": "9a9608e1-0502-4b33-80ec-85531808ab92",
      "GroupPolicyName": "Test Policy 1"
    }
  ]
}

<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>46</Endpoints>
      <GroupCode>-242298043</GroupCode>
      <GroupDescription>Description of test group 1</GroupDescription>
      <GroupId>6289968a-dc91-4228-9140-066b8b8c18b1</GroupId>
      <GroupName>Test Group 1</GroupName>
      <GroupPolicyId>9a9608e1-0502-4b33-80ec-85531808ab92</GroupPolicyId>
      <GroupPolicyName>Test Policy 1</GroupPolicyName>
    </GetGroupsResponseModel_Group>
  </Groups>
  <TotalCount>1</TotalCount>
</GetGroupsResponseModel>