UserManagerServices.GetSingleGroup Method

UserManagerServicesGetSingleGroup Method

Ingeniux CMS Web Services API

Retrieves the full details of a single User Group by its unique Id

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<GroupEditorData> GetSingleGroup(
	GetSingleItemParam data
)

Public Function GetSingleGroup ( 
	data As GetSingleItemParam
) As XHRServiceResponseGeneric(Of GroupEditorData)

public:
virtual XHRServiceResponseGeneric<GroupEditorData^>^ GetSingleGroup(
	GetSingleItemParam^ data
) sealed

abstract GetSingleGroup : 
        data : GetSingleItemParam -> XHRServiceResponseGeneric<GroupEditorData> 
override GetSingleGroup : 
        data : GetSingleItemParam -> XHRServiceResponseGeneric<GroupEditorData>

Parameters

data

Type: GetSingleItemParam

Object containing the unique Id of the User Group

Examples

Sample JSON input

JavaScript

Copy

{
    "data": {
        "itemId": "UserGroups/1"
    }
}

Return Value

Type: XHRServiceResponseGenericGroupEditorData

Full details of the User Group

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "info": {
            "name": "Authors",
            "id": "UserGroups\/1",
            "permissions": [1879681, 1665]
        },
        "users": [{
            "name": "author",
            "email": "",
            "groupsCount": 0,
            "integratedMembershipProvider": "",
            "lastLogin": "20140120T14:00:02",
            "pagesCount": 0,
            "readLanguages": "en-us",
            "receiveWorkFlowNotificationMail": false,
            "userId": "ingeniux\\author",
            "writeLanguages": "en-us"
        }]
    }
}

Remarks

If User Group doesn't exist, returns error status

Reference

UserManagerServices Class

IngeniuxCMService Namespace