PageCreationRulesAdminServicesGetRuleParents Method

Ingeniux CMS Web Services API

Retrieves the existing Parent Page entries detailed information for given Page Creation Rule

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

public XHRServiceResponseGeneric<PageCreationRuleParentsInfo> GetRuleParents(
	PcrGetParentsParam data
)

Parameters

data
Type: PcrGetParentsParam

Information on the Page Creation Rules and Ids of the parent pages

Examples

Sample JSON input
JavaScript
{
    "data": {
        "ruleId": "PageCreationRules/65",
        "pageIds": "x87"
    }
}

Return Value

Type: XHRServiceResponseGenericPageCreationRuleParentsInfo

Details of all existing parent pages

Examples

Sample JSON return
JavaScript
{
    "code": 0,
    "error": null,
    "message": {
        "parents": [{
            "name": "Test",
            "id": "x87",
            "accessible": true,
            "icon": 99,
            "parentOnly": false,
            "path": "Site\/Internal Components\/Test"
        }]
    }
}
Remarks

If Page Creation Rule with given Id doesn't exist, returns error status

If provided parent ids contains non existing Pages, those ids will be ignored. Only information on the valid Pages will be returned.

See Also

Reference