TaxonomyTreeServices.GetCategoriesInfo Method

TaxonomyTreeServicesGetCategoriesInfo Method

Ingeniux CMS Web Services API

Retrieves basic information of Categories by their Ids

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<CategoryListItem[]> GetCategoriesInfo(
	string[] categoryIds
)

Public Function GetCategoriesInfo ( 
	categoryIds As String()
) As XHRServiceResponseGeneric(Of CategoryListItem())

public:
virtual XHRServiceResponseGeneric<array<CategoryListItem^>^>^ GetCategoriesInfo(
	array<String^>^ categoryIds
) sealed

abstract GetCategoriesInfo : 
        categoryIds : string[] -> XHRServiceResponseGeneric<CategoryListItem[]> 
override GetCategoriesInfo : 
        categoryIds : string[] -> XHRServiceResponseGeneric<CategoryListItem[]>

Parameters

categoryIds

Type: SystemString

Array of Ids of Categories

Examples

Sample JSON input

JavaScript

Copy

{
    "categoryIds": ["CategoryNodes/34", "CategoryNodes/33", "CategoryNodes/66"]
}

Return Value

Type: XHRServiceResponseGenericCategoryListItem

Array of basic information for the given Categories, including Id, Name and Path.

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": [{
        "name": "Cestida",
        "id": "CategoryNodes\/34",
        "path": "Animalia\/Ctenophora\/Cestida"
    }, {
        "name": "Cydippida",
        "id": "CategoryNodes\/33",
        "path": "Animalia\/Ctenophora\/Cydippida"
    }, {
        "name": "Monera",
        "id": "CategoryNodes\/67",
        "path": "Monera"
    }]
}

Remarks

All non-existing Categories will be bypassed.

Reference

TaxonomyTreeServices Class

IngeniuxCMService Namespace