GET api/userGroups/search?page={page}&recordsPerPage={recordsPerPage}&query={query}

Search user groups.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
page

Page number.

 integer

Required
recordsPerPage

Records per page.

 integer

Required
query

Query, default is an empty string.

 string

Default value is

Body Parameters

None.

Response Information

Resource Description

UserGroupCollection
NameDescriptionTypeAdditional information
Groups

Collection of Groups

 Collection of UserGroup

None.
Pagination

Pagination for Groups

 Pagination

None.

Response Formats

application/json, text/json

Sample: 
{
  "Groups": [
    {
      "UserGroupId": 1,
      "OrgId": 2,
      "UserGroupName": "sample string 3",
      "Description": "sample string 4",
      "CreatedOn": "2024-09-21T02:43:53.5194969+00:00",
      "NoOfMembers": 6
    },
    {
      "UserGroupId": 1,
      "OrgId": 2,
      "UserGroupName": "sample string 3",
      "Description": "sample string 4",
      "CreatedOn": "2024-09-21T02:43:53.5194969+00:00",
      "NoOfMembers": 6
    }
  ],
  "Pagination": {
    "CurrentPage": 1,
    "TotalRecords": 2,
    "RecordsPerPage": 3
  }
}

application/xml, text/xml

Sample: 
<UserGroupCollection xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Groups>
    <UserGroup>
      <UserGroupId>1</UserGroupId>
      <OrgId>2</OrgId>
      <UserGroupName>sample string 3</UserGroupName>
      <Description>sample string 4</Description>
      <CreatedOn>2024-09-21T02:43:53.5194969+00:00</CreatedOn>
      <NoOfMembers>6</NoOfMembers>
    </UserGroup>
    <UserGroup>
      <UserGroupId>1</UserGroupId>
      <OrgId>2</OrgId>
      <UserGroupName>sample string 3</UserGroupName>
      <Description>sample string 4</Description>
      <CreatedOn>2024-09-21T02:43:53.5194969+00:00</CreatedOn>
      <NoOfMembers>6</NoOfMembers>
    </UserGroup>
  </Groups>
  <Pagination>
    <CurrentPage>1</CurrentPage>
    <TotalRecords>2</TotalRecords>
    <RecordsPerPage>3</RecordsPerPage>
  </Pagination>
</UserGroupCollection>