GET api/userGroups/userGroup/{userGroupId}
Get a user group by id.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| userGroupId |
A user group id. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
UserGroup| Name | Description | Type | Additional information |
|---|---|---|---|
| UserGroupId |
User Group Id. |
integer |
None. |
| OrgId |
Orgnisation Id. |
integer |
None. |
| UserGroupName |
User Group Name. |
string |
None. |
| Description |
Group Description. |
string |
None. |
| CreatedOn |
Group created on date. |
date |
None. |
| NoOfMembers |
Number of members for the group. |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"UserGroupId": 1,
"OrgId": 2,
"UserGroupName": "sample string 3",
"Description": "sample string 4",
"CreatedOn": "2024-11-10T20:44:02.1444214+00:00",
"NoOfMembers": 6
}
application/xml, text/xml
Sample:
<UserGroup xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <UserGroupId>1</UserGroupId> <OrgId>2</OrgId> <UserGroupName>sample string 3</UserGroupName> <Description>sample string 4</Description> <CreatedOn>2024-11-10T20:44:02.1444214+00:00</CreatedOn> <NoOfMembers>6</NoOfMembers> </UserGroup>
