'
Show / Hide Table of Contents

Class DesignAreaRestrictionController

The Design Area Restriction 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/DesignAreaRestriction

Methods

Add(Guid, Guid[])

Add area restrictions for design

Declaration
public JsonResult Add(Guid designID, Guid[] areaIDs)
Parameters
Type Name Description
System.Guid designID

The id of the design to be updated.

System.Guid[] areaIDs

An array of areaID of the areas that has to be added to area restrictions of the design.

Returns
Type Description
System.Web.Mvc.JsonResult

A Json encoded boolean. true if the delete succeeded, else false.

Delete(Guid, Guid[])

Delete area restrictions for design

Declaration
public JsonResult Delete(Guid designID, Guid[] areaIDs)
Parameters
Type Name Description
System.Guid designID

The id of the design that needs to be updated.

System.Guid[] areaIDs

An array of areaID of the Areas whose area restrictions of the design has to be deleted.

Returns
Type Description
System.Web.Mvc.JsonResult

A Json encoded boolean. true if the delete succeeded, else false.

GetForDesign(Guid)

List area restrictions for design

Declaration
public JsonResult GetForDesign(Guid designID)
Parameters
Type Name Description
System.Guid designID

The id of the design that needs the area restrictions to be listed.

Returns
Type Description
System.Web.Mvc.JsonResult

If there exists any area restriction returns a list of the restricted areaIDs, else return an empty list.

Back to top Generated by DocFX