UserGroupSelectionServicesGetUserGroupsForWorkflowAdd Method

Ingeniux CMS Web Services API

Retrieves the collection of Users or User Groups available to assign the Page to, when Page is added to Workflow.

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

public XHRServiceResponseGeneric<UserGroupSelectionData> GetUserGroupsForWorkflowAdd(
	string pageId,
	string workflowId,
	bool getGroups
)

Parameters

pageId
Type: SystemString
Id of the Page that will be added to Workflow
workflowId
Type: SystemString
Id of the Workflow Definition the Page will be added to
getGroups
Type: SystemBoolean
Whether to retrieve Users or User Groups

Return Value

Type: XHRServiceResponseGenericUserGroupSelectionData

Collection of basic information of either Users and User Groups

Examples

Sample JSON return - Users
JavaScript
{
    "code": 0,
    "error": null,
    "message": {
        "groupName": "",
        "groups": [],
        "users": [{
            "name": "abusbin",
            "active": false,
            "email": "",
            "lastLogin": null,
            "userId": "INGENIUX\\abusbin"
        }, {
            "name": "author",
            "active": false,
            "email": "",
            "lastLogin": "2014-01-20",
            "userId": "ingeniux\\author"
        }, {
            "name": "t",
            "active": false,
            "email": "t@i.com",
            "lastLogin": null,
            "userId": "t"
        }, {
            "name": "Turtle Master",
            "active": false,
            "email": "awang@ingeniux.com",
            "lastLogin": "2014-01-27",
            "userId": "INGENIUX\\awang"
        }]
    }
}
Examples

Sample JSON return - User Groups
JavaScript
{
    "code": 0,
    "error": null,
    "message": {
        "groupName": null,
        "groups": [{
            "name": "Administrators",
            "active": true,
            "groupId": "UserGroup\/1",
            "id": "UserGroup\/1",
            "userRights": [32, 0]
        }, {
            "name": "Authors",
            "active": true,
            "groupId": "UserGroups\/1",
            "id": "UserGroups\/1",
            "userRights": [1355393, 511]
        }],
        "users": []
    }
}
Remarks

If Page or Workflow Defintion doesn't exist, returns error status

See Also

Reference