Class ScheduleController
The Schedule 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/Schedule
Methods
Create(ScheduleModel)
Creates a new schedule using the specified parameters.
Declaration
public ActionResult Create(ScheduleModel model)Parameters
| Type | Name | Description |
|---|---|---|
| ScheduleModel | model | Model of the schedule to be created. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.ActionResult | The ID associated with the new schedule, if successfully created. |
Delete(Guid)
Deletes the schedule as specified by the id.
Declaration
public JsonResult Delete(Guid id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | id | ID of the schedule to be deleted. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json encoded boolean. true if the deletion was successful, false if not. |
Get(Guid)
Get the schedule information for the schedule with the specified ID.
Declaration
public JsonResult Get(Guid id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | id | The ID of the schedule. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json encoded instance of the |
GetDigitalBookingLineZonesWithOverwrittenSchedule(Guid)
Get the list of digital booking line zones that has overwritten schedule
Declaration
public ActionResult GetDigitalBookingLineZonesWithOverwrittenSchedule(Guid id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | id | The ID of the schedule. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.ActionResult | An array of DigitalBookingLineZone Models that has the overwritten schedule |
GetForDigitalBookingLine(Guid)
Get the schedule information for all schedules for a digital booking line.
Declaration
public JsonResult GetForDigitalBookingLine(Guid digitalBookingLineId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | digitalBookingLineId | The ID of the digital booking line. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json encoded array of instances of the |
GetMany(Guid[])
Get the schedule information for all schedule with the specified IDs.
Declaration
public JsonResult GetMany(Guid[] ids)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid[] | ids | The IDs of the schedules. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.JsonResult | A Json encoded array of instances of the |
GetScheduleContent(Guid)
Gets the content of a schedule.
Declaration
public ActionResult GetScheduleContent(Guid id)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | id | The ID of the schedule. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.ActionResult | A Json encoded array of |
SetScheduleContent(ScheduleContentModel)
Sets the content of a schedule.
Declaration
public ActionResult SetScheduleContent(ScheduleContentModel model)Parameters
| Type | Name | Description |
|---|---|---|
| ScheduleContentModel | model | Model of the scheduling information. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.ActionResult | A Json encoded boolean. true if the change was successful, false if not. |
Update(Nullable<Guid>, Nullable<Guid>, Nullable<Boolean>)
Updates a schedule with the specified parameters.
Declaration
public ActionResult Update(Guid? id, Guid? scheduleID, bool? isPrimary)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Guid> | id | ID of the schedule to be updated. |
| System.Nullable<System.Guid> | scheduleID | ID of the schedule to be updated. Can be used as an alternative to the |
| System.Nullable<System.Boolean> | isPrimary | New value of the "IsPrimary" field. |
Returns
| Type | Description |
|---|---|
| System.Web.Mvc.ActionResult | A Json encoded boolean. true if the update was successful, false if not. |