UserGroupSelectionServices.GetUsersAndGroups Method

UserGroupSelectionServicesGetUsersAndGroups Method

Ingeniux CMS Web Services API

Retrieves collection of Users and UserGroups.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<UsersAndGroupsList> GetUsersAndGroups(
	bool users,
	bool groups,
	bool extended = false,
	string groupId = ""
)

Public Function GetUsersAndGroups ( 
	users As Boolean,
	groups As Boolean,
	Optional extended As Boolean = false,
	Optional groupId As String = ""
) As XHRServiceResponseGeneric(Of UsersAndGroupsList)

public:
virtual XHRServiceResponseGeneric<UsersAndGroupsList^>^ GetUsersAndGroups(
	bool users, 
	bool groups, 
	bool extended = false, 
	String^ groupId = L""
) sealed

abstract GetUsersAndGroups : 
        users : bool * 
        groups : bool * 
        ?extended : bool * 
        ?groupId : string 
(* Defaults:
        let _extended = defaultArg extended false
        let _groupId = defaultArg groupId ""
*)
-> XHRServiceResponseGeneric<UsersAndGroupsList> 
override GetUsersAndGroups : 
        users : bool * 
        groups : bool * 
        ?extended : bool * 
        ?groupId : string 
(* Defaults:
        let _extended = defaultArg extended false
        let _groupId = defaultArg groupId ""
*)
-> XHRServiceResponseGeneric<UsersAndGroupsList>

Parameters

users: Type: SystemBoolean
[Missing <param name="users"/> documentation for "M:IngeniuxCMService.UserGroupSelectionServices.GetUsersAndGroups(System.Boolean,System.Boolean,System.Boolean,System.String)"]
groups: Type: SystemBoolean
[Missing <param name="groups"/> documentation for "M:IngeniuxCMService.UserGroupSelectionServices.GetUsersAndGroups(System.Boolean,System.Boolean,System.Boolean,System.String)"]
extended (Optional): Type: SystemBoolean
Whether to produce extended information or basic information on each User/User Group
groupId (Optional): Type: SystemString
Id of the User Group to filter User with. If provided, only Users belong to the Group are returned.

Return Value

Type: XHRServiceResponseGenericUsersAndGroupsList

Object containing collection of Users and User Groups

Examples

Sample JSON return - extended is false

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "groups": [{
            "name": "Administrators",
            "active": true,
            "groupId": "UserGroup\/1",
            "id": "UserGroup\/1",
            "userRights": [32, 0],
            "pcrsCount": 0,
            "usersCount": 0,
            "wfDefsCount": 0
        }, {
            "name": "Authors",
            "active": true,
            "groupId": "UserGroups\/1",
            "id": "UserGroups\/1",
            "userRights": [1355393, 511],
            "pcrsCount": 0,
            "usersCount": 0,
            "wfDefsCount": 0
        }],
        "users": [{
            "name": "abusbin",
            "active": false,
            "email": "",
            "lastLogin": "",
            "userId": "INGENIUX%5Cabusbin",
            "groupsCount": 0,
            "integratedMembershipProvider": null,
            "readLanguages": null,
            "receiveWorkFlowNotificationMail": false,
            "writeLanguages": null
        }, {
            "name": "author",
            "active": false,
            "email": "",
            "lastLogin": "2014-01-20",
            "userId": "ingeniux%5Cauthor",
            "groupsCount": 0,
            "integratedMembershipProvider": null,
            "readLanguages": null,
            "receiveWorkFlowNotificationMail": false,
            "writeLanguages": null
        }, {
            "name": "t",
            "active": false,
            "email": "t%40i.com",
            "lastLogin": "",
            "userId": "t",
            "groupsCount": 0,
            "integratedMembershipProvider": null,
            "readLanguages": null,
            "receiveWorkFlowNotificationMail": false,
            "writeLanguages": null
        }, {
            "name": "Turtle%20Master",
            "active": false,
            "email": "awang%40ingeniux.com",
            "lastLogin": "2014-01-27",
            "userId": "INGENIUX%5Cawang",
            "groupsCount": 0,
            "integratedMembershipProvider": null,
            "readLanguages": null,
            "receiveWorkFlowNotificationMail": false,
            "writeLanguages": null
        }]
    }
}

Remarks

If groupId is provided, but the Group doesn't exist, returns empty Users list.

Reference

UserGroupSelectionServices Class

IngeniuxCMService Namespace