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: 9.0.565.0 (9.0.565)
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: XHRServiceResponseGenericCategoryRecurseInfoArray of ancestors information, each item indicate its parent id and children
Examples
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%2FBadges%20-%204",
"permissions": [{
"name": "Everyone",
"id": "0",
"accessLevel": 2
}],
"permissionsInherited": true,
"synonyms": [],
"translated": true,
"typeName": "",
"visibility": 1
},
"title": "Badges%20-%204"
}, {
"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%2FCareers",
"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%20Blogs",
"originalTypeName": "",
"path": "Carefusion%2FCE%20Blogs",
"permissions": [{
"name": "Everyone",
"id": "0",
"accessLevel": 2
}],
"permissionsInherited": true,
"synonyms": [],
"translated": false,
"typeName": "",
"visibility": 1
},
"title": "CE%20Blogs"
}, {
"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%2FCountry",
"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%20Categories",
"originalTypeName": "",
"path": "Carefusion%2FFunctional%20Categories",
"permissions": [{
"name": "Everyone",
"id": "0",
"accessLevel": 2
}],
"permissionsInherited": true,
"synonyms": [],
"translated": false,
"typeName": "",
"visibility": 1
},
"title": "Functional%20Categories"
}, {
"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%20Products",
"originalTypeName": "",
"path": "Carefusion%2FOur%20Products",
"permissions": [{
"name": "Everyone",
"id": "0",
"accessLevel": 2
}],
"permissionsInherited": true,
"synonyms": [],
"translated": false,
"typeName": "",
"visibility": 1
},
"title": "Our%20Products"
}, {
"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%2FPersonalization",
"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%20Type",
"originalTypeName": "",
"path": "Carefusion%2FResource%20Type",
"permissions": [{
"name": "Everyone",
"id": "0",
"accessLevel": 2
}],
"permissionsInherited": true,
"synonyms": [],
"translated": false,
"typeName": "",
"visibility": 1
},
"title": "Resource%20Type"
}, {
"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%20Results%20Type",
"originalTypeName": "",
"path": "Carefusion%2FSearch%20Results%20Type",
"permissions": [{
"name": "Everyone",
"id": "0",
"accessLevel": 2
}],
"permissionsInherited": true,
"synonyms": [],
"translated": false,
"typeName": "",
"visibility": 1
},
"title": "Search%20Results%20Type"
}, {
"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%2FSupport",
"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%2FVideos",
"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%2FResource%20Type%2FBrochure",
"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%20Study",
"originalTypeName": "",
"path": "Carefusion%2FResource%20Type%2FCase%20Study",
"permissions": [{
"name": "Everyone",
"id": "0",
"accessLevel": 2
}],
"permissionsInherited": true,
"synonyms": [],
"translated": false,
"typeName": "",
"visibility": 1
},
"title": "Case%20Study"
}, {
"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%2FResource%20Type%2FFAQ",
"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%2FResource%20Type%2FPoster",
"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%2FResource%20Type%2FTestAus",
"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%20Guide",
"originalTypeName": "",
"path": "Carefusion%2FResource%20Type%2FUser%20Guide",
"permissions": [{
"name": "Everyone",
"id": "0",
"accessLevel": 2
}],
"permissionsInherited": true,
"synonyms": [],
"translated": false,
"typeName": "",
"visibility": 1
},
"title": "User%20Guide"
}, {
"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%2FResource%20Type%2FWhitepaper",
"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