Class DigitalBookingLineController

The Digital Booking Line 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/DigitalBookingLine

Methods

AddDigitalFace(Guid, Guid)

Adds a digital face to the digital booking line.

Declaration

public ActionResult AddDigitalFace(Guid digitalBookingLineID, Guid digitalFaceID)

Parameters

Type	Name	Description
System.Guid	digitalBookingLineID	ID of the digital booking line where the digital face is to be added.
System.Guid	digitalFaceID	ID of the digital face to be added.

Returns

Type	Description
System.Web.Mvc.ActionResult	true if the addition was successful.

Create(DigitalBookingLineModel)

Creates a new digital booking line using the specified parameters.

Declaration

public ActionResult Create(DigitalBookingLineModel model)

Parameters

Type	Name	Description
DigitalBookingLineModel	model	Model of the digital booking line to be created.

Returns

Type	Description
System.Web.Mvc.ActionResult	The ID associated with the new digital booking line if successfully created.

Delete(Guid)

Deletes the digital booking line as specified by the id.

Declaration

public ActionResult Delete(Guid id)

Parameters

Type	Name	Description
System.Guid	id	ID of the digital booking line to be deleted.

Returns

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

GetOverbookedFaces(Guid)

Returns the list of overbooked faceIds in a digital booking line

Declaration

public ActionResult GetOverbookedFaces(Guid digitalBookingLineID)

Parameters

Type	Name	Description
System.Guid	digitalBookingLineID	ID of the digital booking line whose faces have to be checked for overbooking

Returns

Type	Description
System.Web.Mvc.ActionResult	A Json encoded array of elements. If there exists no digital faces/zones that are overbooked, the array will be empty.

ListDigitalBookings(Guid)

Lists all digital face bookings for a digital booking line. Including faces booked through a face pack.

Declaration

public ActionResult ListDigitalBookings(Guid digitalBookingLineID)

Parameters

Type	Name	Description
System.Guid	digitalBookingLineID	ID of the digital booking line.

Returns

Type	Description
System.Web.Mvc.ActionResult	A Json encoded array of elements. If the segment has no digital faces, the array will be empty.

ListDigitalFaceBookings(Guid)

Lists the digital face bookings for a digital booking line.

Declaration

public ActionResult ListDigitalFaceBookings(Guid digitalBookingLineID)

Parameters

Type	Name	Description
System.Guid	digitalBookingLineID	ID of the digital booking line.

Returns

Type	Description
System.Web.Mvc.ActionResult	A Json encoded array of elements. If the segment has no digital face/zone bookings, the array will be empty.

Remarks

This method only returns bookings for faces that have been booked directly. Faces that have been booked through a face pack are not included.

ListDigitalFacePackBookings(Guid)

Lists the digital face pack bookings for a digital booking line.

Declaration

public ActionResult ListDigitalFacePackBookings(Guid digitalBookingLineID)

Parameters

Type	Name	Description
System.Guid	digitalBookingLineID	ID of the digital booking line.

Returns

Type	Description
System.Web.Mvc.ActionResult	A Json encoded array of elements. If the segment has no digital faces pack bookings, the array will be empty.

RemoveDigitalFace(Guid, Guid)

Declaration

public ActionResult RemoveDigitalFace(Guid digitalBookingLineID, Guid digitalFaceID)

Parameters

Type	Name	Description
System.Guid	digitalBookingLineID
System.Guid	digitalFaceID

Returns

Type	Description
System.Web.Mvc.ActionResult

Stop(Guid[])

Stops one or more digital booking lines.

Declaration

public JsonResult Stop(Guid[] ids)

Parameters

Type	Name	Description
System.Guid[]	ids	IDs of the digital booking lines to stop.

Returns

Type	Description
System.Web.Mvc.JsonResult	A Json encoded boolean. true if the digital booking lines were successfully stopped.

Update(Guid, String, String, Nullable<DateTime>, Nullable<DateTime>, Nullable<Guid>, Nullable<Int32>, Nullable<Guid>, Nullable<Single>, Nullable<Guid>, String, Nullable<Int32>)

Updates the digital booking line with the specified parameters.

Declaration

public ActionResult Update(Guid id, string name, string description, DateTime? startDate, DateTime? endDate, Guid? scheduleTemplateID, int? spotLength, Guid? contentSeparationTypeID, float? saturation, Guid? followedByDigitalBookingLineID, string groupingCategory, int? groupingOrder)

Parameters

Type	Name	Description
System.Guid	id	ID of the digital booking line to be updated.
System.String	name	Name of the Digital Booking Line.
System.String	description	Description of the Digital Booking Line.
System.Nullable<System.DateTime>	startDate	Start Date of the Digital Booking Line.
System.Nullable<System.DateTime>	endDate	End Date of the Digital Booking Line. (Exclusive End Date)
System.Nullable<System.Guid>	scheduleTemplateID	ID of the Schedule Template to use for the Digital Booking Line.
System.Nullable<System.Int32>	spotLength	Spot Length (in seconds) of the Digital Booking Line.
System.Nullable<System.Guid>	contentSeparationTypeID	Which type of Content Separation to use for the Digital Booking Line.
System.Nullable<System.Single>	saturation	Saturation ratio of the Digital Booking Line. Normal saturation is 1.
System.Nullable<System.Guid>	followedByDigitalBookingLineID	ID of another Digital Booking Line that should play immediately after this one.
System.String	groupingCategory	Grouping category.
System.Nullable<System.Int32>	groupingOrder	Grouping order.

Returns

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