UserManagerServices.SaveSingleGroup Method

UserManagerServicesSaveSingleGroup Method

Ingeniux CMS Web Services API

Updates an existing User Group with new data

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<SaveGroupResult> SaveSingleGroup(
	SaveGroupInput data
)

Public Function SaveSingleGroup ( 
	data As SaveGroupInput
) As XHRServiceResponseGeneric(Of SaveGroupResult)

public:
virtual XHRServiceResponseGeneric<SaveGroupResult^>^ SaveSingleGroup(
	SaveGroupInput^ data
) sealed

abstract SaveSingleGroup : 
        data : SaveGroupInput -> XHRServiceResponseGeneric<SaveGroupResult> 
override SaveSingleGroup : 
        data : SaveGroupInput -> XHRServiceResponseGeneric<SaveGroupResult>

Parameters

data

Type: SaveGroupInput

Object containing updated details of existing User Group

Examples

Sample JSON input

JavaScript

Copy

{
    "data": {
        "info": {
            "name": "Authors",
            "id": "UserGroups/1",
            "permissions": [1879685, 1665],
            "newEntry": false
        },
        "users": ["ingeniux\\author", "ingeniux\\dhillis", "ingeniux\\shauns"]
    }
}

Return Value

Type: XHRServiceResponseGenericSaveGroupResult

The basic information of the update User Group, plus information of which Users were affected with this update.

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "name": "Authors",
        "groupId": "UserGroups\/1",
        "pcrsCount": 1,
        "secRootsCount": 0,
        "usersAffected": {
            "added": ["User\/ingeniux___dhillis", "User\/ingeniux___shauns"],
            "removed": ["User\/ingeniux___dhillis", "User\/ingeniux___shauns"]
        },
        "usersCount": 3,
        "wfDefsCount": 1
    }
}

Reference

UserManagerServices Class

IngeniuxCMService Namespace