GET api/UserGroups?pageNumber={pageNumber}&itemsPerPage={itemsPerPage}&systemGroupsOnly={systemGroupsOnly}&includeEveryoneGroup={includeEveryoneGroup}

Request Information

URI Parameters

Name	Type	Additional information
pageNumber	integer	Default value is 1
itemsPerPage	integer	Default value is 50
systemGroupsOnly	boolean	Default value is False
includeEveryoneGroup	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

PaginatedResultsOfPermissionGroup

Name	Type	Additional information
TotalPages	integer	None.
CurrentPage	integer	None.
Results	Collection of PermissionGroup	None.
Count	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalPages": 1,
  "CurrentPage": 2,
  "Results": [
    {
      "Claims": [
        {
          "ClaimType": "sample string 1",
          "ClaimValue": "sample string 2"
        },
        {
          "ClaimType": "sample string 1",
          "ClaimValue": "sample string 2"
        }
      ],
      "InstitutionIdentity": "8c7a852d-72b9-42d7-8dd6-d617bc7546a6",
      "IsSystemGroup": true,
      "IsAdminGroup": true,
      "Scopes": [
        0,
        0
      ],
      "Identity": "ce599bf7-990c-4447-b572-afb432ab9cdd",
      "Name": "sample string 5"
    },
    {
      "Claims": [
        {
          "ClaimType": "sample string 1",
          "ClaimValue": "sample string 2"
        },
        {
          "ClaimType": "sample string 1",
          "ClaimValue": "sample string 2"
        }
      ],
      "InstitutionIdentity": "8c7a852d-72b9-42d7-8dd6-d617bc7546a6",
      "IsSystemGroup": true,
      "IsAdminGroup": true,
      "Scopes": [
        0,
        0
      ],
      "Identity": "ce599bf7-990c-4447-b572-afb432ab9cdd",
      "Name": "sample string 5"
    }
  ],
  "Count": 3
}

application/xml, text/xml

Sample:

<PaginatedResultsOfPermissionGroupqMSKJDOU xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model">
  <Count>3</Count>
  <CurrentPage>2</CurrentPage>
  <Results>
    <PermissionGroup>
      <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">ce599bf7-990c-4447-b572-afb432ab9cdd</Identity>
      <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 5</Name>
      <Claims xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model.ToDoModels">
        <d4p1:PermissionClaim>
          <d4p1:ClaimType>sample string 1</d4p1:ClaimType>
          <d4p1:ClaimValue>sample string 2</d4p1:ClaimValue>
        </d4p1:PermissionClaim>
        <d4p1:PermissionClaim>
          <d4p1:ClaimType>sample string 1</d4p1:ClaimType>
          <d4p1:ClaimValue>sample string 2</d4p1:ClaimValue>
        </d4p1:PermissionClaim>
      </Claims>
      <InstitutionIdentity>8c7a852d-72b9-42d7-8dd6-d617bc7546a6</InstitutionIdentity>
      <IsAdminGroup>true</IsAdminGroup>
      <IsSystemGroup>true</IsSystemGroup>
      <Scopes xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
        <d4p1:ScopeType>RB</d4p1:ScopeType>
        <d4p1:ScopeType>RB</d4p1:ScopeType>
      </Scopes>
    </PermissionGroup>
    <PermissionGroup>
      <Identity xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">ce599bf7-990c-4447-b572-afb432ab9cdd</Identity>
      <Name xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">sample string 5</Name>
      <Claims xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model.ToDoModels">
        <d4p1:PermissionClaim>
          <d4p1:ClaimType>sample string 1</d4p1:ClaimType>
          <d4p1:ClaimValue>sample string 2</d4p1:ClaimValue>
        </d4p1:PermissionClaim>
        <d4p1:PermissionClaim>
          <d4p1:ClaimType>sample string 1</d4p1:ClaimType>
          <d4p1:ClaimValue>sample string 2</d4p1:ClaimValue>
        </d4p1:PermissionClaim>
      </Claims>
      <InstitutionIdentity>8c7a852d-72b9-42d7-8dd6-d617bc7546a6</InstitutionIdentity>
      <IsAdminGroup>true</IsAdminGroup>
      <IsSystemGroup>true</IsSystemGroup>
      <Scopes xmlns:d4p1="http://schemas.datacontract.org/2004/07/Scientia.Platform.Library.Security">
        <d4p1:ScopeType>RB</d4p1:ScopeType>
        <d4p1:ScopeType>RB</d4p1:ScopeType>
      </Scopes>
    </PermissionGroup>
  </Results>
  <TotalPages>1</TotalPages>
</PaginatedResultsOfPermissionGroupqMSKJDOU>