SystemOptionsServices.RemoveGroupProfileForToolbar Method

SystemOptionsServicesRemoveGroupProfileForToolbar Method

Ingeniux CMS Web Services API

Removes the User Group override on Toolbar buttons listing setting

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

Syntax

C++

Copy

public XHRServiceResponseGeneric<GroupProfileRemovalResult> RemoveGroupProfileForToolbar(
	GroupProfileRemovalParam data
)

Public Function RemoveGroupProfileForToolbar ( 
	data As GroupProfileRemovalParam
) As XHRServiceResponseGeneric(Of GroupProfileRemovalResult)

public:
virtual XHRServiceResponseGeneric<GroupProfileRemovalResult^>^ RemoveGroupProfileForToolbar(
	GroupProfileRemovalParam^ data
) sealed

abstract RemoveGroupProfileForToolbar : 
        data : GroupProfileRemovalParam -> XHRServiceResponseGeneric<GroupProfileRemovalResult> 
override RemoveGroupProfileForToolbar : 
        data : GroupProfileRemovalParam -> XHRServiceResponseGeneric<GroupProfileRemovalResult>

Parameters

data

Type: GroupProfileRemovalParam

Object containing User Group Id for remove the profile for

Examples

Sample JSON input

JavaScript

Copy

{
    "data": {
        "groupId": "UserGroups/1"
    }
}

Return Value

Type: XHRServiceResponseGenericGroupProfileRemovalResult

Object containing the User Group Id to remove the profile for and whether the removal was successful

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "settingName": null,
        "groupId": "UserGroups\/1",
        "removed": true
    }
}

Remarks

If override profile doesn't exist for the given User Group, returns false

Reference

SystemOptionsServices Class

IngeniuxCMService Namespace