TaxonomyTreeServices.RemoveCategory Method

TaxonomyTreeServicesRemoveCategory Method

Ingeniux CMS Web Services API

Permenantly deletes a Category from the Taxonomy system. This operation also removes the association of this Category to all Pages.

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<CategoryRemovalInfo> RemoveCategory(
	CategoryAssociationManipulationInput data
)

Public Function RemoveCategory ( 
	data As CategoryAssociationManipulationInput
) As XHRServiceResponseGeneric(Of CategoryRemovalInfo)

public:
virtual XHRServiceResponseGeneric<CategoryRemovalInfo^>^ RemoveCategory(
	CategoryAssociationManipulationInput^ data
) sealed

abstract RemoveCategory : 
        data : CategoryAssociationManipulationInput -> XHRServiceResponseGeneric<CategoryRemovalInfo> 
override RemoveCategory : 
        data : CategoryAssociationManipulationInput -> XHRServiceResponseGeneric<CategoryRemovalInfo>

Parameters

data

Type: CategoryAssociationManipulationInput

Object containing the Id of the Category to delete

Examples

Sample JSON input

JavaScript

Copy

{
    "data": {
        "categoryId": "CategoryNodes/65"
    }
}

Return Value

Type: XHRServiceResponseGenericCategoryRemovalInfo

Object containing the deleted Category Node's Id

Examples

Sample JSON return

JavaScript

Copy

    "code": 0,
    "error": null,
    "message": {
        "removedCategoryId": "CategoryNodes\/65"
    }
}

Remarks

If Category doesn't exist, returns error status.

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

Reference

TaxonomyTreeServices Class

IngeniuxCMService Namespace