'
Show / Hide Table of Contents

Class DesignSiteRestrictionController

The Design Site 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/DesignSiteRestriction

Methods

Add(Guid, Guid[])

Add site restrictions for design

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

The id of the design to be updated.

System.Guid[] siteIDs

An array of siteID of the sites that has to be added to site 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 site restrictions for design

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

The id of the design that needs to be updated.

System.Guid[] siteIDs

An array of siteID of the sites whose site 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 site restrictions for design

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

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

Returns
Type Description
System.Web.Mvc.JsonResult

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

Back to top Generated by DocFX