Click or drag to resize

TaxonomyTreeServicesGetChildrenPaged Method


Retrieves a range of Category nodes information, that are children of specified Category Node

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.6.492
Syntax
public XHRServiceResponseGeneric<CategoryPageInfo> GetChildrenPaged(
	CategoryTreeNodeInfo node,
	string pageId,
	string pageSchemaName,
	string selectedLocale,
	int pIndex
)

Parameters

node  CategoryTreeNodeInfo

The information on parent node

Example

Sample JSON input

JavaScript
{
    "index": 0,
    "baseId": "CategoryNodes/97",
    "idPrefix": "tutt_",
    "widgetId": "tutt___CategoryNodes/97",
    "objectId": "tutt___CategoryNodes/97"
}
pageId  String
Id of the page that associated with, if empty, return all categories
pageSchemaName  String
Schema of the page, when specified, only return categories allowed by this schema
selectedLocale  String
affect the name of returned categories, name become translation in that category if exists
pIndex  Int32
Page number, start from 0, per page has no more than 100 records

Return Value

XHRServiceResponseGenericCategoryPageInfo

Collection of child categories in that specific page

Example

Sample JSON return

JavaScript
{
    "ContentFreezeEndTime": "",
    "ContentFreezeStartTime": "",
    "code": 0,
    "error": null,
    "message": {
        "nodes": [
            {
                "objectId": "tutt___CategoryNodes\/103",
                "widgetId": "tutt___CategoryNodes\/103",
                "isFolder": false,
                "props": {
                    "associatedPages": [],
                    "creationLocale": "en-us",
                    "depth": 0,
                    "description": "",
                    "everyoneName": "Everyone",
                    "externalId": "Implementation",
                    "id": "CategoryNodes\/103",
                    "idPrefix": "tutt_",
                    "nextPageIndex": 0,
                    "originalDescription": "",
                    "originalTitle": "Implementation",
                    "originalTypeName": "",
                    "path": "Audience/Implementation",
                    "permissions": [
                        {
                            "name": "Everyone",
                            "id": "0",
                            "accessLevel": 2
                        }
                    ],
                    "permissionsInherited": true,
                    "synonyms": [],
                    "translated": true,
                    "typeName": "",
                    "visibility": 1
                },
                "title": "Implementation"
            },
            {
                "objectId": "tutt___CategoryNodes\/99",
                "widgetId": "tutt___CategoryNodes\/99",
                "isFolder": false,
                "props": {
                    "associatedPages": [],
                    "creationLocale": "en-us",
                    "depth": 0,
                    "description": "",
                    "everyoneName": "Everyone",
                    "externalId": "internal",
                    "id": "CategoryNodes\/99",
                    "idPrefix": "tutt_",
                    "nextPageIndex": 0,
                    "originalDescription": "",
                    "originalTitle": "internal",
                    "originalTypeName": "",
                    "path": "Audience/internal",
                    "permissions": [
                        {
                            "name": "Everyone",
                            "id": "0",
                            "accessLevel": 2
                        }
                    ],
                    "permissionsInherited": true,
                    "synonyms": [],
                    "translated": true,
                    "typeName": "",
                    "visibility": 1
                },
                "title": "internal"
            },
            {
                "objectId": "tutt___CategoryNodes\/100",
                "widgetId": "tutt___CategoryNodes\/100",
                "isFolder": false,
                "props": {
                    "associatedPages": [],
                    "creationLocale": "en-us",
                    "depth": 0,
                    "description": "",
                    "everyoneName": "Everyone",
                    "externalId": "print",
                    "id": "CategoryNodes\/100",
                    "idPrefix": "tutt_",
                    "nextPageIndex": 0,
                    "originalDescription": "",
                    "originalTitle": "print",
                    "originalTypeName": "",
                    "path": "Audience/print",
                    "permissions": [
                        {
                            "name": "Everyone",
                            "id": "0",
                            "accessLevel": 2
                        }
                    ],
                    "permissionsInherited": true,
                    "synonyms": [],
                    "translated": true,
                    "typeName": "",
                    "visibility": 1
                },
                "title": "print"
            },
            {
                "objectId": "tutt___CategoryNodes\/101",
                "widgetId": "tutt___CategoryNodes\/101",
                "isFolder": false,
                "props": {
                    "associatedPages": [],
                    "creationLocale": "en-us",
                    "depth": 0,
                    "description": "",
                    "everyoneName": "Everyone",
                    "externalId": "qualcomm",
                    "id": "CategoryNodes\/101",
                    "idPrefix": "tutt_",
                    "nextPageIndex": 0,
                    "originalDescription": "",
                    "originalTitle": "qualcomm",
                    "originalTypeName": "",
                    "path": "Audience/qualcomm",
                    "permissions": [
                        {
                            "name": "Everyone",
                            "id": "0",
                            "accessLevel": 2
                        }
                    ],
                    "permissionsInherited": true,
                    "synonyms": [],
                    "translated": true,
                    "typeName": "",
                    "visibility": 1
                },
                "title": "qualcomm"
            },
            {
                "objectId": "tutt___CategoryNodes\/104",
                "widgetId": "tutt___CategoryNodes\/104",
                "isFolder": false,
                "props": {
                    "associatedPages": [],
                    "creationLocale": "en-us",
                    "depth": 0,
                    "description": "",
                    "everyoneName": "Everyone",
                    "externalId": "System",
                    "id": "CategoryNodes\/104",
                    "idPrefix": "tutt_",
                    "nextPageIndex": 0,
                    "originalDescription": "",
                    "originalTitle": "System",
                    "originalTypeName": "",
                    "path": "Audience/System",
                    "permissions": [
                        {
                            "name": "Everyone",
                            "id": "0",
                            "accessLevel": 2
                        }
                    ],
                    "permissionsInherited": true,
                    "synonyms": [],
                    "translated": true,
                    "typeName": "",
                    "visibility": 1
                },
                "title": "System"
            },
            {
                "objectId": "tutt___CategoryNodes\/102",
                "widgetId": "tutt___CategoryNodes\/102",
                "isFolder": false,
                "props": {
                    "associatedPages": [],
                    "creationLocale": "en-us",
                    "depth": 0,
                    "description": "",
                    "everyoneName": "Everyone",
                    "externalId": "web",
                    "id": "CategoryNodes\/102",
                    "idPrefix": "tutt_",
                    "nextPageIndex": 0,
                    "originalDescription": "",
                    "originalTitle": "web",
                    "originalTypeName": "",
                    "path": "Audience/web",
                    "permissions": [
                        {
                            "name": "Everyone",
                            "id": "0",
                            "accessLevel": 2
                        }
                    ],
                    "permissionsInherited": true,
                    "synonyms": [],
                    "translated": true,
                    "typeName": "",
                    "visibility": 1
                },
                "title": "web"
            }
        ],
        "page": 0,
        "totalPages": 1
    }
}
See Also