GET api/UserGroups

Fetch a list of usergroups

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

ListResultOfUserGroup

Name	Description	Type	Additional information
TotalCount		integer	None.
Items		Collection of UserGroup	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalCount": 1,
  "Items": [
    {
      "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
    },
    {
      "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:

<ListResultOfUserGroupHWVxl9UY xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ControlKeeper.ApiModel">
  <Items>
    <UserGroup>
      <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>
    <UserGroup>
      <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>
  </Items>
  <TotalCount>1</TotalCount>
</ListResultOfUserGroupHWVxl9UY>