TaxonomyTreeServicesSetCategoryPermissions Method

Ingeniux CMS Web Services API

Updates the security permission for a Category

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

public XHRServiceResponseGeneric<CategoryInfo> SetCategoryPermissions(
	SetCategoriesPermissions data
)

Parameters

data
Type: SetCategoriesPermissions

Object containing Category Id and its new collection of Node-Level permissions.

Examples

Sample JSON input
JavaScript
{
    "data": {
        "categoryId": "CategoryNodes/4",
        "permissions": {
            "inherited": false,
            "data": [{
                "Id": "0",
                "Access": "1"
            }, {
                "Id": "UserGroup/1",
                "Access": "2"
            }]
        }
    }
}

Return Value

Type: XHRServiceResponseGenericCategoryInfo

Full details of the updated Category

Examples

Sample JSON return
JavaScript
{
    "code": 0,
    "error": null,
    "message": {
        "objectId": "__CategoryNodes\/4",
        "widgetId": "__CategoryNodes\/4",
        "isFolder": true,
        "props": {
            "associatedPages": null,
            "creationLocale": "en-us",
            "depth": 2,
            "description": "",
            "everyoneName": "Everyone",
            "externalId": "",
            "id": "CategoryNodes\/4",
            "idPrefix": null,
            "originalDescription": "",
            "originalTitle": "Ctenophora",
            "originalTypeName": "Phylum",
            "path": "Animalia/Ctenophora",
            "permissions": [{
                "name": "Everyone",
                "id": "0",
                "accessLevel": 1
            }, {
                "name": "Administrators",
                "id": "UserGroup\/1",
                "accessLevel": 2
            }],
            "permissionsInherited": false,
            "synonyms": [],
            "translated": true,
            "typeName": "Phylum",
            "visibility": 1
        },
        "title": "Ctenophora"
    }
}
Remarks

If Category doesn't exist, returns error status.

This operation requires current User to have the permission to manager Taxonomy System. If not, returns error status.

See Also

Reference