TaxonomyTreeServices.GetCategoryAncestorIds Method

TaxonomyTreeServicesGetCategoryAncestorIds Method

Ingeniux CMS Web Services API

Retrieves the list of all ancestor Category Node Ids for a given Category Node

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<string[][]> GetCategoryAncestorIds(
	CategoryGetAncestorsPathInput data
)

Public Function GetCategoryAncestorIds ( 
	data As CategoryGetAncestorsPathInput
) As XHRServiceResponseGeneric(Of String()())

public:
virtual XHRServiceResponseGeneric<array<array<String^>^>^>^ GetCategoryAncestorIds(
	CategoryGetAncestorsPathInput^ data
) sealed

abstract GetCategoryAncestorIds : 
        data : CategoryGetAncestorsPathInput -> XHRServiceResponseGeneric<string[][]> 
override GetCategoryAncestorIds : 
        data : CategoryGetAncestorsPathInput -> XHRServiceResponseGeneric<string[][]>

Parameters

data

Type: CategoryGetAncestorsPathInput

Object containing the current Category Node Id, and whether to return error status if Category doesn't exist.

Examples

Sample JSON input

JavaScript

Copy

{
    "data": {
        "searchIds": "CategoryNodes/34",
        "alertMissingCategory": false
    }
}

Remarks

If "alertMissingCategory" is set to false, returns empty array if Category doesn't exist.

Return Value

Type: XHRServiceResponseGenericString

Array of all ancestor Category Node Ids. Starting from the Root Category.

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": [["CategoryNodes\/3", "CategoryNodes\/4", "CategoryNodes\/34"]]
}

Reference

TaxonomyTreeServices Class

IngeniuxCMService Namespace