Class AdvertiserCategoryController

The AdvertiserCategory 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/AdvertiserCategory

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<AdvertiserCategory, Ayuda.BMS.Splash.Shared.Models.AdvertiserCategoryModel, AdvertiserCategory>.AreLocalizableFieldsBeingUpdated(System.Collections.Specialized.NameValueCollection)

Create(AdvertiserCategoryModel)

Creates a new Advertiser Category using the specified parameters.

Declaration

public JsonResult Create(AdvertiserCategoryModel model)

Parameters

Type	Name	Description
AdvertiserCategoryModel	model	Model of the Advertiser Category to be created.

Returns

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

Delete(Guid)

Deletes the Advertiser Category as specified by the id.

Declaration

public JsonResult Delete(Guid id)

Parameters

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

Returns

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

GetByCode(String)

Gets the Advertiser Category by Code.

Declaration

public JsonResult GetByCode(string code)

Parameters

Type	Name	Description
System.String	code	Code of the Advertiser Category

Returns

Type	Description
System.Web.Mvc.JsonResult	The Advertiser Category if found.

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)

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

Updates the Advertiser Category with the specified parameters.

Declaration

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

Parameters

Type	Name	Description
System.Guid	id	ID of the Advertiser Category to be updated.
System.String	culture	Language to update (if updating localizable fields).
System.String	code	Code of the Advertiser Category.
System.String	name	Name of the Advertiser Category. Localizable.
System.Nullable<System.Guid>	parentAdvertiserCategoryID	ID of the Advertiser Category under which this Area should be created, forming a hierarchy.
System.Nullable<System.Boolean>	isLive	True if the Advertiser Category is available and usable. False if it is archived.

Returns

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