'
Show / Hide Table of Contents

Class MediaTypeGroupController

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

Methods

AreLocalizableFieldsBeingUpdated(NameValueCollection)

Declaration
protected bool AreLocalizableFieldsBeingUpdated(NameValueCollection requestData)
Parameters
Type Name Description
System.Collections.Specialized.NameValueCollection requestData
Returns
Type Description
System.Boolean

Create(MediaTypeGroupModel)

Creates a new Media Type Group using the specified parameters.

Declaration
public JsonResult Create(MediaTypeGroupModel model)
Parameters
Type Name Description
MediaTypeGroupModel model

Model of the Media Type Group to be created.

Returns
Type Description
System.Web.Mvc.JsonResult

The ID associated with the new Media Type Group if successfully created.

Delete(Guid)

Deletes the Media Type Group as specified by the id.

Declaration
public JsonResult Delete(Guid id)
Parameters
Type Name Description
System.Guid id

ID of the MediaTypeGroup to be deleted.

Returns
Type Description
System.Web.Mvc.JsonResult

true if the deletion was successful.

GetAll()

Gets all MediaTypeGroups

Declaration
public JsonResult GetAll()
Returns
Type Description
System.Web.Mvc.JsonResult

All MediaTypeGroups.

GetByCode(String)

Gets the MediaTypeGroup by Code.

Declaration
public JsonResult GetByCode(string code)
Parameters
Type Name Description
System.String code

Code of the MediaTypeGroup

Returns
Type Description
System.Web.Mvc.JsonResult

The MediaTypeGroup if found.

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

Updates the Media Type Group with the specified parameters.

Declaration
public JsonResult Update(Guid id, string culture, string code, string name, string description, Guid? mediaTypeCategoryID, bool? isDigital, bool? isCommodity, bool? isLive)
Parameters
Type Name Description
System.Guid id

ID of the Media Type Group to be updated.

System.String culture

Language to update (if updating localizable fields).

System.String code

Code of the Media Type Group.

System.String name

Name of the Media Type Group. Localizable.

System.String description

Description of the Media Type Group. Localizable.

System.Nullable<System.Guid> mediaTypeCategoryID

ID of the Media Type Category to which the Media Type Group belongs.

System.Nullable<System.Boolean> isDigital

Indicates if the Media Type Group is used for Digital inventory.

System.Nullable<System.Boolean> isCommodity

Indicates if the Media Type Group is for Commodities.

System.Nullable<System.Boolean> isLive

True if the Media Type Group is available and usable. False if it is archived.

Returns
Type Description
System.Web.Mvc.JsonResult

true if the update was successful.

Back to top Generated by DocFX