TaxonomyTreeServices.SetCategorySynonyms Method

TaxonomyTreeServicesSetCategorySynonyms Method

Ingeniux CMS Web Services API

Updates the Synonyms listing under specified locale for a Category

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<bool> SetCategorySynonyms(
	SetCategorySynonymsInput data
)

Public Function SetCategorySynonyms ( 
	data As SetCategorySynonymsInput
) As XHRServiceResponseGeneric(Of Boolean)

public:
virtual XHRServiceResponseGeneric<bool>^ SetCategorySynonyms(
	SetCategorySynonymsInput^ data
) sealed

abstract SetCategorySynonyms : 
        data : SetCategorySynonymsInput -> XHRServiceResponseGeneric<bool> 
override SetCategorySynonyms : 
        data : SetCategorySynonymsInput -> XHRServiceResponseGeneric<bool>

Parameters

data

Type: SetCategorySynonymsInput

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

Examples

Sample JSON input

JavaScript

Copy

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

Copy

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

Reference

TaxonomyTreeServices Class

IngeniuxCMService Namespace