Class DigitalBookingLineZoneController
The Digital Booking Line Zone 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/DigitalBookingLineZone
Methods
Create(DigitalBookingLineZoneModel)
Creates a new digital booking line zone.
Declaration
public JsonResult Create(DigitalBookingLineZoneModel model)Parameters
| Type | Name | Description |
|---|---|---|
| DigitalBookingLineZoneModel | model | The model of the design to create. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json encoded string containing the id of the newly created design. |
CreateMany(Guid, Guid[])
Books many faces to a digital booking line.
Declaration
public JsonResult CreateMany(Guid digitalBookingLineID, Guid[] faceIDs)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | digitalBookingLineID | The ID of the digital booking line. |
| System.Guid[] | faceIDs | The IDs of the faces. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json encoded string containing the id of the newly created design. |
Delete(Guid)
Delete a digital booking line zone.
Declaration
public JsonResult Delete(Guid id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | id | The id of the digital booking line zone to delete. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json encoded boolean. true if the delete succeeded, else false. |
Get(Guid)
Gets all properties of a given digital booking line zone.
Declaration
public JsonResult Get(Guid id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | id | ID of the digital booking line zone. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | Model of the digital booking line zone corresponding to the ID. |
MoveDigitalBookingLineZone(Guid, Guid)
Moves a digitalBookingLineZone to the target digital booking line. Replaces the target digital booking line's scheduling with the digitalBookingLineZone's original digital booking line's schedule. Any scheduling overriden at the digitalBookingLineZone's level will be preserved if it fits within the time span of the target digital booking line. Any scheduling of any kind which is not within the time span of the target digital booking line will not be preserved. (For example: if you scheduled content for june but your target booking line is in may, nothing will be scheduled for june as nothing is effectively booked for june)
Declaration
public JsonResult MoveDigitalBookingLineZone(Guid digitalBookinglineZoneID, Guid targetDigitalBookingLineID)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | digitalBookinglineZoneID | The ID of the DigitalBookingLineZone which is to be transferred to the target digital booking line |
| System.Guid | targetDigitalBookingLineID | The ID of the DigitalBookingLine to which the digitalBookingLineZone will be moved |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json encoded boolean. true if the delete succeeded, else false. |
Remarks
Overwrites the target digital booking line's schedule.
Stop(Guid[])
Stops one or more digital bookings.
Declaration
public JsonResult Stop(Guid[] ids)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid[] | ids | IDs of the digital bookings to stop. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json encoded boolean. true if the digital bookings were successfully stopped. |
Update(Nullable<Guid>, Nullable<Guid>, Nullable<DateTime>, Nullable<DateTime>, Nullable<Guid>)
Update the specified digital booking line zone.
Only the ID of the digital booking line zone and the fields to be updated need to be specified.
It is also possible to send a whole instance of the
Declaration
public JsonResult Update(Guid? id, Guid? digitalBookingLineZoneID, DateTime? startDateTimeUtc, DateTime? endDateTimeUtc, Guid? facePackDigitalBookingLineZoneID)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Guid> | id | The id of the digital booking line zone to update. |
| System.Nullable<System.Guid> | digitalBookingLineZoneID | The id of the digital booking line zone to update. Can be used as an alternate to the |
| System.Nullable<System.DateTime> | startDateTimeUtc | Disabled. Null or a date. |
| System.Nullable<System.DateTime> | endDateTimeUtc | Disabled. Null or a date. |
| System.Nullable<System.Guid> | facePackDigitalBookingLineZoneID | The new face pack digital booking line zone. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json encoded boolean. true if the update succeeded, else false. |