TaxonomyTreeServicesGetCategorySynonyms Method

Retrieves the collection of Synonyms for given Category under specified Locale

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.6.492

Syntax

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

Public Function GetCategorySynonyms ( 
	data As GetCategorySynonymsInput
) As XHRServiceResponseGeneric(Of String())

public:
virtual XHRServiceResponseGeneric<array<String^>^>^ GetCategorySynonyms(
	GetCategorySynonymsInput^ data
) sealed

abstract GetCategorySynonyms : 
        data : GetCategorySynonymsInput -> XHRServiceResponseGeneric<string[]> 
override GetCategorySynonyms : 
        data : GetCategorySynonymsInput -> XHRServiceResponseGeneric<string[]>

Parameters

data GetCategorySynonymsInput

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

Example

Sample JSON input

JavaScript

Copy

{
    "data": {
        "categoryId": "CategoryNodes/3",
        "locale": "en-us"
    }
}

Remarks

Synonyms are language specific

Return Value

XHRServiceResponseGenericString

Array of Synonyms under the given locale

Example

Sample JSON return

JavaScript

Copy

;
            {
                "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".

Reference

TaxonomyTreeServices Class

IngeniuxCMService Namespace