Class AreaGroupController

The AreaGroup Controller is a controller that allows data to be retrieved and updated within the Ayuda Platform.

Namespace: Ayuda.BMS.Splash.Areas.Pi.Controllers

Remarks

This web service can be accessed using an address similar to the following: https://[AYUDA DEPLOYMENT URL]/Juice/Pi/AreaGroup

Methods

AreLocalizableFieldsBeingUpdated(NameValueCollection)

Declaration

protected override bool AreLocalizableFieldsBeingUpdated(NameValueCollection requestData)

Parameters

Type	Name	Description
System.Collections.Specialized.NameValueCollection	requestData

Returns

Type	Description
System.Boolean

Overrides

Ayuda.BMS.Splash.Controllers.BaseController<AreaGroup, Ayuda.BMS.Splash.Shared.Models.AreaGroupModel, AreaGroup>.AreLocalizableFieldsBeingUpdated(System.Collections.Specialized.NameValueCollection)

Create(AreaGroupModel)

Creates a new Area Group using the specified parameters.

Declaration

public JsonResult Create(AreaGroupModel model)

Parameters

Type	Name	Description
AreaGroupModel	model	Model of the Area Group to be created.

Returns

Type	Description
System.Web.Mvc.JsonResult	The ID associated with the new Area Group if successfully created.

Delete(Guid)

Deletes the Area Group as specified by the id.

Declaration

public JsonResult Delete(Guid id)

Parameters

Type	Name	Description
System.Guid	id	ID of the AreaGroup to be deleted.

Returns

Type	Description
System.Web.Mvc.JsonResult	true if the deletion was successful.

GetByCode(String)

Gets the Area Group by Code.

Declaration

public JsonResult GetByCode(string code)

Parameters

Type	Name	Description
System.String	code	Code of the Area Group

Returns

Type	Description
System.Web.Mvc.JsonResult	The Area Group if found.

LinkArea(Guid, Guid)

Links an Area to an Area Group

Declaration

public JsonResult LinkArea(Guid areaGroupID, Guid areaID)

Parameters

Type	Name	Description
System.Guid	areaGroupID	ID of the Area Group that will contain the Area.
System.Guid	areaID	ID of the Area to link.

Returns

Type	Description
System.Web.Mvc.JsonResult	true if the linking was successful.

OnActionExecuting(ActionExecutingContext)

Declaration

protected override void OnActionExecuting(ActionExecutingContext filterContext)

Parameters

Type	Name	Description
System.Web.Mvc.ActionExecutingContext	filterContext

Overrides

System.Web.Mvc.Controller.OnActionExecuting(System.Web.Mvc.ActionExecutingContext)

UnlinkArea(Guid, Guid)

Unlinks an Area from an Area Group

Declaration

public JsonResult UnlinkArea(Guid areaGroupID, Guid areaID)

Parameters

Type	Name	Description
System.Guid	areaGroupID	ID of the Area Group from which to unlink the Area.
System.Guid	areaID	ID of the Area to unlink.

Returns

Type	Description
System.Web.Mvc.JsonResult	true if the unlinking was successful.

Update(Guid, String, String, String, Nullable<Boolean>)

Updates the Area Group with the specified parameters.

Declaration

public JsonResult Update(Guid id, string culture, string code, string name, bool? isLive)

Parameters

Type	Name	Description
System.Guid	id	ID of the Area Group to be updated.
System.String	culture	Language to update (if updating localizable fields).
System.String	code	Code of the Area Group.
System.String	name	Name of the Area Group. Localizable.
System.Nullable<System.Boolean>	isLive	True if the Area Group is available and usable. False if it is archived.

Returns

Type	Description
System.Web.Mvc.JsonResult	true if the update was successful.