TaxonomyTreeServices.GetChildren Method

TaxonomyTreeServicesGetChildren Method

Ingeniux CMS Web Services API

Retrieves children Nodes of a specific Category Node in the Taxonomy Tree

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<CategoryInfo[]> GetChildren(
	CategoryTreeNodeInfo node,
	string pageId,
	string pageSchemaName,
	string selectedLocale,
	int pIndex
)

Public Function GetChildren ( 
	node As CategoryTreeNodeInfo,
	pageId As String,
	pageSchemaName As String,
	selectedLocale As String,
	pIndex As Integer
) As XHRServiceResponseGeneric(Of CategoryInfo())

public:
virtual XHRServiceResponseGeneric<array<CategoryInfo^>^>^ GetChildren(
	CategoryTreeNodeInfo^ node, 
	String^ pageId, 
	String^ pageSchemaName, 
	String^ selectedLocale, 
	int pIndex
) sealed

abstract GetChildren : 
        node : CategoryTreeNodeInfo * 
        pageId : string * 
        pageSchemaName : string * 
        selectedLocale : string * 
        pIndex : int -> XHRServiceResponseGeneric<CategoryInfo[]> 
override GetChildren : 
        node : CategoryTreeNodeInfo * 
        pageId : string * 
        pageSchemaName : string * 
        selectedLocale : string * 
        pIndex : int -> XHRServiceResponseGeneric<CategoryInfo[]>

Parameters

node

Type: CategoryTreeNodeInfo

Information on the Category Node to retrieve children for

Examples

Sample JSON input

JavaScript

Copy

{
    "widgetId": "tta__CategoryNodes/3",
    "objectId": "tta__CategoryNodes/3",
    "index": 0,
    "idPrefix": "tta",
    "baseId": "CategoryNodes/3"
}

Remarks

The following of "widgetId" and "objectId" of the category must be "tta__[category node id]". If we are retrieving root nodes, the "widgetId" must be "tta_0", "objectId" is optional.

pageId

Type: SystemString

[Missing <param name="pageId"/> documentation for "M:IngeniuxCMService.TaxonomyTreeServices.GetChildren(IngeniuxCMService.CategoryTreeNodeInfo,System.String,System.String,System.String,System.Int32)"]

pageSchemaName

Type: SystemString
The Schema friendly name to filter out root Category nodes. This parameter is only needed when retrieving root Category nodes that the given schema allows

selectedLocale

Type: SystemString
The currently selected Content Locale. The locale value affects the labels of Category nodes information.

pIndex

Type: SystemInt32

[Missing <param name="pIndex"/> documentation for "M:IngeniuxCMService.TaxonomyTreeServices.GetChildren(IngeniuxCMService.CategoryTreeNodeInfo,System.String,System.String,System.String,System.Int32)"]

Return Value

Type: XHRServiceResponseGenericCategoryInfo

Array of full details for all child Category nodes of given Category node.

Examples

Sample JSON return

JavaScript

Copy

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

Remarks

Taxonomy Tree doesn't have the concept of order. The result is always sorted alphabetically.

Reference

TaxonomyTreeServices Class

IngeniuxCMService Namespace