GET api/UserManagement/GetUserGroup?groupId={groupId}

Get all the user groups withing the organization. Users details assigned to each group will not be populated.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupId

Group id

integer

Required

Body Parameters

None.

Response Information

Resource Description

List of user groups in the organization

ResponseOfListOfUserGroup
NameDescriptionTypeAdditional information
StatusCode

StatusCode

None.

Message

string

None.

Data

Collection of UserGroup

None.

Response Formats

application/json, text/json

Sample:
{
  "StatusCode": 1000,
  "Message": "sample string 1",
  "Data": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "OrganizationId": 4,
      "CreatedBy": 5,
      "ModifiedBy": 6,
      "Thumbnail": "sample string 7",
      "DepartmentId": 8,
      "Users": [
        null,
        {
          "ProfileId": "",
          "UserId": "",
          "OrganizationId": "",
          "Email": null,
          "FirstName": null,
          "MiddleName": null,
          "MiddleInitials": null,
          "LastName": null,
          "Rating": 0.0,
          "Link": null,
          "Locale": null,
          "Picture": null,
          "Thumbnail": null,
          "ThumbnailURL": null,
          "IsActive": false,
          "IsDeleted": false,
          "IsWelcomeVisible": false,
          "IsVideoHelpVisible": false,
          "IsDefault": false,
          "AddressLine1": null,
          "AddressLine2": null,
          "ZipCode": null,
          "StateCode": null,
          "City": null,
          "County": null,
          "Country": null,
          "CountryCode": null,
          "Address": null,
          "OfficialName": null,
          "Suffix": null,
          "Title": null,
          "JobTitle": null,
          "PhoneNumber": null,
          "UserSignatureId": 0,
          "Signature": null,
          "Initials": null,
          "SignatureDescription": null,
          "UserSignatures": null,
          "ProfileStatus": 0,
          "Settings": null,
          "CreatedBy": null,
          "ModifiedBy": null,
          "UserType": 0,
          "IsMerged": false,
          "BusinessName": null,
          "TimeZoneDetails": null
        }
      ]
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "OrganizationId": 4,
      "CreatedBy": 5,
      "ModifiedBy": 6,
      "Thumbnail": "sample string 7",
      "DepartmentId": 8,
      "Users": [
        null,
        {
          "ProfileId": "",
          "UserId": "",
          "OrganizationId": "",
          "Email": null,
          "FirstName": null,
          "MiddleName": null,
          "MiddleInitials": null,
          "LastName": null,
          "Rating": 0.0,
          "Link": null,
          "Locale": null,
          "Picture": null,
          "Thumbnail": null,
          "ThumbnailURL": null,
          "IsActive": false,
          "IsDeleted": false,
          "IsWelcomeVisible": false,
          "IsVideoHelpVisible": false,
          "IsDefault": false,
          "AddressLine1": null,
          "AddressLine2": null,
          "ZipCode": null,
          "StateCode": null,
          "City": null,
          "County": null,
          "Country": null,
          "CountryCode": null,
          "Address": null,
          "OfficialName": null,
          "Suffix": null,
          "Title": null,
          "JobTitle": null,
          "PhoneNumber": null,
          "UserSignatureId": 0,
          "Signature": null,
          "Initials": null,
          "SignatureDescription": null,
          "UserSignatures": null,
          "ProfileStatus": 0,
          "Settings": null,
          "CreatedBy": null,
          "ModifiedBy": null,
          "UserType": 0,
          "IsMerged": false,
          "BusinessName": null,
          "TimeZoneDetails": null
        }
      ]
    }
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.