SchemaDesignerServicesToggleFavoriteAvailability Method

Ingeniux CMS Web Services API

Toggles whether the Schema Field Favorite entry is available to everybody, or only the creator.

Namespace:  IngeniuxCMService
Assembly:  IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.3.70
Syntax

public XHRServiceResponseGeneric<SchemaPublicSetRequest> ToggleFavoriteAvailability(
	SchemaPublicSetRequest data
)

Parameters

data
Type: SchemaPublicSetRequest

Information on the Schema Field Favorite entry to toggle availability one

Examples

Sample JSON input
JavaScript
{
    "data": {
        "FavoriteID": "SchemaFieldFavorites/33",
        "ToBePublic": true
    }
}

Return Value

Type: XHRServiceResponseGenericSchemaPublicSetRequest

The input data if toggling is successful. Error status if the Schema Field Favorite entry doesn't exist.

Examples

Sample JSON return
JavaScript
{
    "code": 0,
    "error": null,
    "message": {
        "FavoriteID": "SchemaFieldFavorites\/33",
        "ToBePublic": true
    }
}
See Also

Reference