SiteTreeServicesGetChildPages Method Ingeniux CMS Web Services API
Retrieves collection of the information of Children of a given Page. Returns up to 50 entries, starting from given index.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)
Syntax
Copy
public XHRServiceResponseGeneric<PageNodeInformation[]> GetChildPages(
	TreeNodeInfo node,
	string pubTarget,
	int nextPageIndex
)

Parameters

node
Type: TreeNodeInfo

Object containing the information of select Page node to retrieve children information for

Examples
Sample JSON input
JavaScript
Copy
{
    "widgetId": "x100",
    "objectId": "x100",
    "index": 1
}
pubTarget
Type: SystemString
Id of the current Publishing Target, optional
nextPageIndex
Type: SystemInt32

Starting index of the returning page, 0 based.

Examples
50 for starting from the 51 first entry and grab next update 50 entries

Return Value

Type: XHRServiceResponseGenericPageNodeInformation

Collection of information on current Page's children, update to 50 entries. Each entry contains properties of the child Page

Examples
Sample JSON return
JavaScript
Copy
{
    "code": 0,
    "error": null,
    "message": [{
        "name": "zBrush",
        "isFolder": false,
        "objectId": "x116",
        "props": {
            "name": "zBrush",
            "allowedCategoryRoots": [],
            "ancestors": ["x1", "x2", "x112"],
            "assignedGroup": null,
            "assignedUser": null,
            "canClaimPage": false,
            "canTranslate": false,
            "checkedOut": false,
            "error": null,
            "icon": 3,
            "isAssignedToOtherUser": false,
            "isEditable": false,
            "isInWorkflow": false,
            "justRecycled": false,
            "languageRootId": "x112",
            "lingualMaps": {
                "clones": [{
                    "name": "zBrush",
                    "id": "x118",
                    "locale": "zh-cn"
                }],
                "master": null
            },
            "locale": "en-us",
            "localeInherited": true,
            "markedForPublish": false,
            "markedForPublishAny": false,
            "markedForPublishPropagated": false,
            "nextPageId": null,
            "nextPageIndex": 0,
            "noDnd": false,
            "numChildPages": 0,
            "pageId": "x116",
            "parentId": null,
            "pendingMasterVersion": 0,
            "referenceProps": {
                "created": "20140122T00:37:10",
                "createdBy": "INGENIUX\\awang",
                "endDate": "00010101T00:00:00",
                "lastModified": "20140127T21:24:37",
                "lastModifiedBy": "User\/INGENIUX___awang",
                "publishAs": "",
                "startDate": "00010101T00:00:00"
            },
            "remoteServer": "",
            "schemaFriendlyName": null,
            "schemaName": "Image",
            "schemaOnLatestVersion": false,
            "securityLevel": 2,
            "userCanCopyPage": true,
            "workflow": null
        },
        "readOnly": false,
        "title": "<span unselectable='on'><img src='\/CMStrunk\/images\/icons\/inactive\/image16.png' \/><\/span>&nbsp;<span unselectable='on' class=''>zBrush<\/span>",
        "widgetId": "x116"
    }, {
        "name": "zBrush",
        "isFolder": false,
        "objectId": "x119",
        "props": {
            "name": "zBrush",
            "allowedCategoryRoots": [],
            "ancestors": ["x1", "x2", "x112"],
            "assignedGroup": null,
            "assignedUser": {
                "name": "Turtle Master",
                "email": "awang@ingeniux.com",
                "userId": "INGENIUX\\awang"
            },
            "canClaimPage": false,
            "canTranslate": false,
            "checkedOut": true,
            "error": null,
            "icon": 3,
            "isAssignedToOtherUser": false,
            "isEditable": true,
            "isInWorkflow": false,
            "justRecycled": false,
            "languageRootId": "x112",
            "lingualMaps": {
                "clones": [{
                    "name": "zBrush",
                    "id": "x120",
                    "locale": "zh-cn"
                }],
                "master": null
            },
            "locale": "en-us",
            "localeInherited": true,
            "markedForPublish": false,
            "markedForPublishAny": false,
            "markedForPublishPropagated": false,
            "nextPageId": null,
            "nextPageIndex": 0,
            "noDnd": false,
            "numChildPages": 0,
            "pageId": "x119",
            "parentId": null,
            "pendingMasterVersion": 0,
            "referenceProps": {
                "created": "20140123T23:49:33",
                "createdBy": "INGENIUX\\awang",
                "endDate": "00010101T00:00:00",
                "lastModified": "20140123T23:49:33",
                "lastModifiedBy": "User\/INGENIUX___awang",
                "publishAs": "",
                "startDate": "00010101T00:00:00"
            },
            "remoteServer": "",
            "schemaFriendlyName": null,
            "schemaName": "Image",
            "schemaOnLatestVersion": false,
            "securityLevel": 2,
            "userCanCopyPage": true,
            "workflow": null
        },
        "readOnly": false,
        "title": "<span unselectable='on'><img src='\/CMStrunk\/images\/icons\/over\/image16.png' \/><\/span>&nbsp;<span unselectable='on' class=''>zBrush<\/span>",
        "widgetId": "x119"
    }]
}
Remarks

If Page doesn't exist, returns error status

This operation will retrieve all to 50 entries. If there are more than 50 child Pages, it will return an additional entry "More Pages..." with id "mpx3". This indicating there are more children to retrieve after current 50 children entries.

See Also

Reference

SiteTreeServices Class
IngeniuxCMService Namespace