UserManagerServicesSaveSingleUser Method

Ingeniux CMS Web Services API

Updates an existing User with new data

Namespace:  IngeniuxCMService
Assembly:  IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.3.70
Syntax

public XHRServiceResponseGeneric<SaveUserResult> SaveSingleUser(
	SaveUserInput data
)

Parameters

data
Type: SaveUserInput

Object containing updated details of the existing User

Examples

Sample JSON input
JavaScript
{
    "data": {
        "info": {
            "name": "Turtle Master",
            "email": "awang@ingeniux.com",
            "receiveWorkFlowNotificationMail": true,
            "id": "INGENIUX\\awang",
            "integratedMembershipProvider": "",
            "readLocales": [{
                "BaseLocale": "en-us",
                "EnglishName": "English (United States)",
                "Locale": "en-us",
                "Name": "English (United States)"
            }, {
                "BaseLocale": "zh-cn",
                "EnglishName": "Chinese (Simplified, PRC)",
                "Locale": "zh-cn",
                "Name": "中文(中华人民共和国)"
            }],
            "writeLocales": [{
                "BaseLocale": "en-us",
                "EnglishName": "English (United States)",
                "Locale": "en-us",
                "Name": "English (United States)"
            }, {
                "BaseLocale": "zh-cn",
                "EnglishName": "Chinese (Simplified, PRC)",
                "Locale": "zh-cn",
                "Name": "中文(中华人民共和国)"
            }],
            "newEntry": false,
            "password": ""
        },
        "groups": ["UserGroups/97", "UserGroups/103", "UserGroups/116", "UserGroups/117", "UserGroup/1"]
    }
}

Return Value

Type: XHRServiceResponseGenericSaveUserResult

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

Examples

Sample JSON return
JavaScript
{
    "code": 0,
    "error": null,
    "message": {
        "name": "Turtle%20Master",
        "email": "awang%40ingeniux.com",
        "receiveWorkFlowNotificationMail": true,
        "groupsAffected": {
            "added": [],
            "removed": []
        },
        "integratedMembershipProvider": "",
        "lastLoginDate": "20140127T14:21:58",
        "pagesCount": 70,
        "userId": "INGENIUX%5Cawang"
    }
}
Remarks

If User doesn't exist, returns error status.

The User's name, user Id, and email information are URI encoded in the return message.

See Also

Reference