TaxonomyTreeServicesCreateNewCategory Method

Ingeniux CMS Web Services API

Creates a new Category Node in a specific Locale.

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

public XHRServiceResponseGeneric<CategoryInfo> CreateNewCategory(
	CategoryCreateUpdateInput data,
	string locale
)

Parameters

data
Type: CategoryCreateUpdateInput

Full details of the new Category Node to create, including the Parent Id.

Examples

Sample JSON input
JavaScript
{
    "parentId": "CategoryNodes/3",
    "idPrefix": "tta",
    "name": "Lophotrochozoa",
    "description": "",
    "externalId": "",
    "typeName": "Phylum"
}
Remarks

To create a new Root Category, specify the "parentId" field of "data" parameter to "0".

locale
Type: SystemString
Specifies the Locale of this new Category Node. This will be the "Creation Locale" of the new Category.

Return Value

Type: XHRServiceResponseGenericCategoryInfo

Full details of the newly created Category

Examples

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

If new Parent Id is not "0", but the new Parent Category doesn't exist, returns error status.

All Name and Path information in the array of Category Nodes are URI encoded.

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

See Also

Reference