Click or drag to resize

TaxonomyTreeServicesSetCategorySynonyms Method


Updates the Synonyms listing under specified locale for a Category

Namespace:  IngeniuxCMService
Assembly:  IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.5.94
Syntax
public XHRServiceResponseGeneric<bool> SetCategorySynonyms(
	SetCategorySynonymsInput data
)

Parameters

data
Type: SetCategorySynonymsInput

Object containing Category Id, environmental Locale, and list of the Synonyms under that Locale

Examples
Sample JSON input
JavaScript
{
    "data": {
        "categoryId": "CategoryNodes/3",
        "locale": "en-us",
        "synonyms": ["Animals", "Creatures that moves"]
    }
}

Return Value

Type: XHRServiceResponseGenericBoolean
True if update successful.
Examples
Sample JSON return
JavaScript
{
    "code": 0,
    "error": null,
    "message": true
}
Remarks

If Category doesn't exist, returns error status.

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

This operation requires current User to have the permission to manager Taxonomy System. If not, returns error status.

See Also