TaxonomyTreeServicesGetCategorySynonyms Method

Ingeniux CMS Web Services API

Retrieves the collection of Synonyms for given Category under specified Locale

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

public XHRServiceResponseGeneric<string[]> GetCategorySynonyms(
	GetCategorySynonymsInput data
)

Parameters

data
Type: GetCategorySynonymsInput

Object containing of the Category and Locale we want to retrieve synonyms under

Examples

Sample JSON input
JavaScript
{
    "data": {
        "categoryId": "CategoryNodes/3",
        "locale": "en-us"
    }
}
Remarks

Synonyms are language specific

Return Value

Type: XHRServiceResponseGenericString

Array of Synonyms under the given locale

Examples

Sample JSON return
JavaScript
{
    "code": 0,
    "error": null,
    "message": ["Animal", "Creatures that moves"]
}
Remarks

If Category doesn't exist, returns error status.

If Locale not specified, default to "en-us".

See Also

Reference