GET api/UserGroups/{id}

Fetch a specific usergroup

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

UserGroup

Name	Type	Additional information
Name	string	None.
RoleId	integer	None.
Type	string	None.
AllowOwnerAccess	boolean	None.
AccessPermissions	Collection of AccessPermission	None.
CompanyId	integer	None.
Id	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "RoleId": 2,
  "Type": "sample string 3",
  "AllowOwnerAccess": true,
  "AccessPermissions": [
    {
      "EntityId": 1,
      "EntityType": "sample string 2",
      "ReadAccess": true,
      "FullAccess": true,
      "Id": 5
    },
    {
      "EntityId": 1,
      "EntityType": "sample string 2",
      "ReadAccess": true,
      "FullAccess": true,
      "Id": 5
    }
  ],
  "CompanyId": 5,
  "Id": 6
}

application/xml, text/xml

Sample:

<UserGroup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ControlKeeper.ApiModel">
  <Id>6</Id>
  <CompanyId>5</CompanyId>
  <AccessPermissions>
    <AccessPermission>
      <Id>5</Id>
      <EntityId>1</EntityId>
      <EntityType>sample string 2</EntityType>
      <FullAccess>true</FullAccess>
      <ReadAccess>true</ReadAccess>
    </AccessPermission>
    <AccessPermission>
      <Id>5</Id>
      <EntityId>1</EntityId>
      <EntityType>sample string 2</EntityType>
      <FullAccess>true</FullAccess>
      <ReadAccess>true</ReadAccess>
    </AccessPermission>
  </AccessPermissions>
  <AllowOwnerAccess>true</AllowOwnerAccess>
  <Name>sample string 1</Name>
  <RoleId>2</RoleId>
  <Type>sample string 3</Type>
</UserGroup>