TaxonomyTreeServicesRecurseToNode Method

Ingeniux CMS Web Services API

Retrieves the entire ancestors collection to the given category. Includes all root categories. Each ancestor entry contains its children entries.

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

public XHRServiceResponseGeneric<CategoryRecurseInfo[]> RecurseToNode(
	string categoryId,
	string pageSchemaName,
	string selectedLocale,
	string idPrefix
)

Parameters

categoryId
Type: SystemString
Id of category to recurse to
pageSchemaName
Type: SystemString
The Schema 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.
idPrefix
Type: SystemString
The prefix to append to the id of each entry

Return Value

Type: XHRServiceResponseGenericCategoryRecurseInfo

Array of ancestors information, each item indicate its parent id and children

Examples

Sample JSON return
JavaScript
{
    "ContentFreezeEndTime": "",
    "ContentFreezeStartTime": "",
    "code": 0,
    "error": null,
    "message": [{
        "children": [{
            "objectId": "tta__CategoryNodes\/211",
            "widgetId": "tta__CategoryNodes\/211",
            "isFolder": true,
            "props": {
                "associatedPages": [],
                "creationLocale": "en-us",
                "depth": 1,
                "description": "",
                "everyoneName": "Everyone",
                "externalId": "",
                "id": "CategoryNodes\/211",
                "idPrefix": "tta",
                "nextPageIndex": 0,
                "originalDescription": "",
                "originalTitle": "Carefusion",
                "originalTypeName": "",
                "path": "Carefusion",
                "permissions": [{
                    "name": "Everyone",
                    "id": "0",
                    "accessLevel": 2
                }],
                "permissionsInherited": true,
                "synonyms": [],
                "translated": false,
                "typeName": "",
                "visibility": 1
            },
            "title": "Carefusion"
        }],
        "myParentId": null
    }, {
        "children": [{
            "objectId": "tta__CategoryNodes\/6",
            "widgetId": "tta__CategoryNodes\/6",
            "isFolder": true,
            "props": {
                "associatedPages": [],
                "creationLocale": "en-us",
                "depth": 2,
                "description": "",
                "everyoneName": "Everyone",
                "externalId": "",
                "id": "CategoryNodes\/6",
                "idPrefix": "tta",
                "nextPageIndex": 0,
                "originalDescription": "",
                "originalTitle": "Badges",
                "originalTypeName": "",
                "path": "Carefusion/Badges - 4",
                "permissions": [{
                    "name": "Everyone",
                    "id": "0",
                    "accessLevel": 2
                }],
                "permissionsInherited": true,
                "synonyms": [],
                "translated": true,
                "typeName": "",
                "visibility": 1
            },
            "title": "Badges - 4"
        }, {
            "objectId": "tta__CategoryNodes\/7",
            "widgetId": "tta__CategoryNodes\/7",
            "isFolder": true,
            "props": {
                "associatedPages": [],
                "creationLocale": "en-us",
                "depth": 2,
                "description": "",
                "everyoneName": "Everyone",
                "externalId": "",
                "id": "CategoryNodes\/7",
                "idPrefix": "tta",
                "nextPageIndex": 0,
                "originalDescription": "",
                "originalTitle": "Careers",
                "originalTypeName": "",
                "path": "Carefusion/Careers",
                "permissions": [{
                    "name": "Everyone",
                    "id": "0",
                    "accessLevel": 2
                }],
                "permissionsInherited": true,
                "synonyms": [],
                "translated": false,
                "typeName": "",
                "visibility": 1
            },
            "title": "Careers"
        }, {
            "objectId": "tta__CategoryNodes\/1",
            "widgetId": "tta__CategoryNodes\/1",
            "isFolder": true,
            "props": {
                "associatedPages": [],
                "creationLocale": "en-us",
                "depth": 2,
                "description": "",
                "everyoneName": "Everyone",
                "externalId": "",
                "id": "CategoryNodes\/1",
                "idPrefix": "tta",
                "nextPageIndex": 0,
                "originalDescription": "",
                "originalTitle": "CE Blogs",
                "originalTypeName": "",
                "path": "Carefusion/CE Blogs",
                "permissions": [{
                    "name": "Everyone",
                    "id": "0",
                    "accessLevel": 2
                }],
                "permissionsInherited": true,
                "synonyms": [],
                "translated": false,
                "typeName": "",
                "visibility": 1
            },
            "title": "CE Blogs"
        }, {
            "objectId": "tta__CategoryNodes\/10",
            "widgetId": "tta__CategoryNodes\/10",
            "isFolder": true,
            "props": {
                "associatedPages": [],
                "creationLocale": "en-us",
                "depth": 2,
                "description": "",
                "everyoneName": "Everyone",
                "externalId": "",
                "id": "CategoryNodes\/10",
                "idPrefix": "tta",
                "nextPageIndex": 0,
                "originalDescription": "",
                "originalTitle": "Country",
                "originalTypeName": "",
                "path": "Carefusion/Country",
                "permissions": [{
                    "name": "Everyone",
                    "id": "0",
                    "accessLevel": 2
                }],
                "permissionsInherited": true,
                "synonyms": [],
                "translated": false,
                "typeName": "",
                "visibility": 1
            },
            "title": "Country"
        }, {
            "objectId": "tta__CategoryNodes\/12",
            "widgetId": "tta__CategoryNodes\/12",
            "isFolder": true,
            "props": {
                "associatedPages": [],
                "creationLocale": "en-us",
                "depth": 2,
                "description": "",
                "everyoneName": "Everyone",
                "externalId": "",
                "id": "CategoryNodes\/12",
                "idPrefix": "tta",
                "nextPageIndex": 0,
                "originalDescription": "",
                "originalTitle": "Functional Categories",
                "originalTypeName": "",
                "path": "Carefusion/Functional Categories",
                "permissions": [{
                    "name": "Everyone",
                    "id": "0",
                    "accessLevel": 2
                }],
                "permissionsInherited": true,
                "synonyms": [],
                "translated": false,
                "typeName": "",
                "visibility": 1
            },
            "title": "Functional Categories"
        }, {
            "objectId": "tta__CategoryNodes\/14",
            "widgetId": "tta__CategoryNodes\/14",
            "isFolder": true,
            "props": {
                "associatedPages": [],
                "creationLocale": "en-us",
                "depth": 2,
                "description": "",
                "everyoneName": "Everyone",
                "externalId": "",
                "id": "CategoryNodes\/14",
                "idPrefix": "tta",
                "nextPageIndex": 0,
                "originalDescription": "",
                "originalTitle": "Our Products",
                "originalTypeName": "",
                "path": "Carefusion%/Our Products",
                "permissions": [{
                    "name": "Everyone",
                    "id": "0",
                    "accessLevel": 2
                }],
                "permissionsInherited": true,
                "synonyms": [],
                "translated": false,
                "typeName": "",
                "visibility": 1
            },
            "title": "Our Products"
        }, {
            "objectId": "tta__CategoryNodes\/354",
            "widgetId": "tta__CategoryNodes\/354",
            "isFolder": true,
            "props": {
                "associatedPages": [],
                "creationLocale": "en-us",
                "depth": 2,
                "description": "",
                "everyoneName": "Everyone",
                "externalId": "",
                "id": "CategoryNodes\/354",
                "idPrefix": "tta",
                "nextPageIndex": 0,
                "originalDescription": "",
                "originalTitle": "Personalization",
                "originalTypeName": "",
                "path": "Carefusion/Personalization",
                "permissions": [{
                    "name": "Everyone",
                    "id": "0",
                    "accessLevel": 2
                }],
                "permissionsInherited": true,
                "synonyms": [],
                "translated": false,
                "typeName": "",
                "visibility": 1
            },
            "title": "Personalization"
        }, {
            "objectId": "tta__CategoryNodes\/20",
            "widgetId": "tta__CategoryNodes\/20",
            "isFolder": true,
            "props": {
                "associatedPages": [],
                "creationLocale": "en-us",
                "depth": 2,
                "description": "",
                "everyoneName": "Everyone",
                "externalId": "",
                "id": "CategoryNodes\/20",
                "idPrefix": "tta",
                "nextPageIndex": 0,
                "originalDescription": "",
                "originalTitle": "Resource Type",
                "originalTypeName": "",
                "path": "Carefusion/Resource Type",
                "permissions": [{
                    "name": "Everyone",
                    "id": "0",
                    "accessLevel": 2
                }],
                "permissionsInherited": true,
                "synonyms": [],
                "translated": false,
                "typeName": "",
                "visibility": 1
            },
            "title": "Resource Type"
        }, {
            "objectId": "tta__CategoryNodes\/82",
            "widgetId": "tta__CategoryNodes\/82",
            "isFolder": true,
            "props": {
                "associatedPages": [],
                "creationLocale": "en-us",
                "depth": 2,
                "description": "",
                "everyoneName": "Everyone",
                "externalId": "",
                "id": "CategoryNodes\/82",
                "idPrefix": "tta",
                "nextPageIndex": 0,
                "originalDescription": "",
                "originalTitle": "Search Results Type",
                "originalTypeName": "",
                "path": "Carefusion/Search Results Type",
                "permissions": [{
                    "name": "Everyone",
                    "id": "0",
                    "accessLevel": 2
                }],
                "permissionsInherited": true,
                "synonyms": [],
                "translated": false,
                "typeName": "",
                "visibility": 1
            },
            "title": "Search Results Type"
        }, {
            "objectId": "tta__CategoryNodes\/84",
            "widgetId": "tta__CategoryNodes\/84",
            "isFolder": true,
            "props": {
                "associatedPages": [],
                "creationLocale": "en-us",
                "depth": 2,
                "description": "",
                "everyoneName": "Everyone",
                "externalId": "",
                "id": "CategoryNodes\/84",
                "idPrefix": "tta",
                "nextPageIndex": 0,
                "originalDescription": "",
                "originalTitle": "Support",
                "originalTypeName": "",
                "path": "Carefusion/Support",
                "permissions": [{
                    "name": "Everyone",
                    "id": "0",
                    "accessLevel": 2
                }],
                "permissionsInherited": true,
                "synonyms": [],
                "translated": false,
                "typeName": "",
                "visibility": 1
            },
            "title": "Support"
        }, {
            "objectId": "tta__CategoryNodes\/385",
            "widgetId": "tta__CategoryNodes\/385",
            "isFolder": true,
            "props": {
                "associatedPages": [],
                "creationLocale": "en-us",
                "depth": 2,
                "description": "",
                "everyoneName": "Everyone",
                "externalId": "",
                "id": "CategoryNodes\/385",
                "idPrefix": "tta",
                "nextPageIndex": 0,
                "originalDescription": "",
                "originalTitle": "Videos",
                "originalTypeName": "",
                "path": "Carefusion/Videos",
                "permissions": [{
                    "name": "Everyone",
                    "id": "0",
                    "accessLevel": 2
                }],
                "permissionsInherited": true,
                "synonyms": [],
                "translated": false,
                "typeName": "",
                "visibility": 1
            },
            "title": "Videos"
        }],
        "myParentId": "CategoryNodes\/211"
    }, {
        "children": [{
            "objectId": "tta__CategoryNodes\/23",
            "widgetId": "tta__CategoryNodes\/23",
            "isFolder": false,
            "props": {
                "associatedPages": [],
                "creationLocale": "en-us",
                "depth": 3,
                "description": "",
                "everyoneName": "Everyone",
                "externalId": "",
                "id": "CategoryNodes\/23",
                "idPrefix": "tta",
                "nextPageIndex": 0,
                "originalDescription": "",
                "originalTitle": "Brochure",
                "originalTypeName": "",
                "path": "Carefusion/Resource Type/Brochure",
                "permissions": [{
                    "name": "Everyone",
                    "id": "0",
                    "accessLevel": 2
                }],
                "permissionsInherited": true,
                "synonyms": [],
                "translated": false,
                "typeName": "",
                "visibility": 1
            },
            "title": "Brochure"
        }, {
            "objectId": "tta__CategoryNodes\/21",
            "widgetId": "tta__CategoryNodes\/21",
            "isFolder": false,
            "props": {
                "associatedPages": [],
                "creationLocale": "en-us",
                "depth": 3,
                "description": "",
                "everyoneName": "Everyone",
                "externalId": "",
                "id": "CategoryNodes\/21",
                "idPrefix": "tta",
                "nextPageIndex": 0,
                "originalDescription": "",
                "originalTitle": "Case Study",
                "originalTypeName": "",
                "path": "Carefusion/Resource Type/Case Study",
                "permissions": [{
                    "name": "Everyone",
                    "id": "0",
                    "accessLevel": 2
                }],
                "permissionsInherited": true,
                "synonyms": [],
                "translated": false,
                "typeName": "",
                "visibility": 1
            },
            "title": "Case Study"
        }, {
            "objectId": "tta__CategoryNodes\/26",
            "widgetId": "tta__CategoryNodes\/26",
            "isFolder": false,
            "props": {
                "associatedPages": [],
                "creationLocale": "en-us",
                "depth": 3,
                "description": "",
                "everyoneName": "Everyone",
                "externalId": "",
                "id": "CategoryNodes\/26",
                "idPrefix": "tta",
                "nextPageIndex": 0,
                "originalDescription": "",
                "originalTitle": "FAQ",
                "originalTypeName": "",
                "path": "Carefusion/Resource Type/FAQ",
                "permissions": [{
                    "name": "Everyone",
                    "id": "0",
                    "accessLevel": 2
                }],
                "permissionsInherited": true,
                "synonyms": [],
                "translated": false,
                "typeName": "",
                "visibility": 1
            },
            "title": "FAQ"
        }, {
            "objectId": "tta__CategoryNodes\/27",
            "widgetId": "tta__CategoryNodes\/27",
            "isFolder": false,
            "props": {
                "associatedPages": [],
                "creationLocale": "en-us",
                "depth": 3,
                "description": "",
                "everyoneName": "Everyone",
                "externalId": "",
                "id": "CategoryNodes\/27",
                "idPrefix": "tta",
                "nextPageIndex": 0,
                "originalDescription": "",
                "originalTitle": "Poster",
                "originalTypeName": "",
                "path": "Carefusion/Resource Type/Poster",
                "permissions": [{
                    "name": "Everyone",
                    "id": "0",
                    "accessLevel": 2
                }],
                "permissionsInherited": true,
                "synonyms": [],
                "translated": false,
                "typeName": "",
                "visibility": 1
            },
            "title": "Poster"
        }, {
            "objectId": "tta__CategoryNodes\/24",
            "widgetId": "tta__CategoryNodes\/24",
            "isFolder": false,
            "props": {
                "associatedPages": [],
                "creationLocale": "en-us",
                "depth": 3,
                "description": "",
                "everyoneName": "Everyone",
                "externalId": "",
                "id": "CategoryNodes\/24",
                "idPrefix": "tta",
                "nextPageIndex": 0,
                "originalDescription": "",
                "originalTitle": "Testimonial",
                "originalTypeName": "",
                "path": "Carefusion/Resource Type/TestAus",
                "permissions": [{
                    "name": "Everyone",
                    "id": "0",
                    "accessLevel": 2
                }],
                "permissionsInherited": true,
                "synonyms": [],
                "translated": true,
                "typeName": "",
                "visibility": 1
            },
            "title": "TestAus"
        }, {
            "objectId": "tta__CategoryNodes\/25",
            "widgetId": "tta__CategoryNodes\/25",
            "isFolder": false,
            "props": {
                "associatedPages": [],
                "creationLocale": "en-us",
                "depth": 3,
                "description": "",
                "everyoneName": "Everyone",
                "externalId": "",
                "id": "CategoryNodes\/25",
                "idPrefix": "tta",
                "nextPageIndex": 0,
                "originalDescription": "",
                "originalTitle": "User Guide",
                "originalTypeName": "",
                "path": "Carefusion/Resource Type/User Guide",
                "permissions": [{
                    "name": "Everyone",
                    "id": "0",
                    "accessLevel": 2
                }],
                "permissionsInherited": true,
                "synonyms": [],
                "translated": false,
                "typeName": "",
                "visibility": 1
            },
            "title": "User Guide"
        }, {
            "objectId": "tta__CategoryNodes\/22",
            "widgetId": "tta__CategoryNodes\/22",
            "isFolder": false,
            "props": {
                "associatedPages": [],
                "creationLocale": "en-us",
                "depth": 3,
                "description": "",
                "everyoneName": "Everyone",
                "externalId": "",
                "id": "CategoryNodes\/22",
                "idPrefix": "tta",
                "nextPageIndex": 0,
                "originalDescription": "",
                "originalTitle": "Whitepaper",
                "originalTypeName": "",
                "path": "Carefusion/Resource Type/Whitepaper",
                "permissions": [{
                    "name": "Everyone",
                    "id": "0",
                    "accessLevel": 2
                }],
                "permissionsInherited": true,
                "synonyms": [],
                "translated": false,
                "typeName": "",
                "visibility": 1
            },
            "title": "Whitepaper"
        }],
        "myParentId": "CategoryNodes\/20"
    }]
}
Remarks

This method may take long time to complete, since it needs to expand all children for all of the Category node's ancestors.

See Also

Reference