Help us shape the 2021 DevExtreme Roadmap.
Take our 5 minute survey.
Web API Service
Documentation
This example demonstrates the Scheduler UI component communicating with a Web API service.
Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Thank you!
We appreciate your feedback.
We appreciate your feedback.
@(Html.DevExtreme().Scheduler()
.ID("scheduler")
.DataSource(d => d.Mvc()
.Controller("SchedulerData")
.Key("AppointmentId")
.LoadAction("Get")
.UpdateAction("Put")
.InsertAction("Post")
.DeleteAction("Delete")
)
.TimeZone("America/Los_Angeles")
.DateSerializationFormat("yyyy-MM-ddTHH:mm:ssZ")
.RemoteFiltering(true)
.Views(new[] {
SchedulerViewType.Day,
SchedulerViewType.WorkWeek,
SchedulerViewType.Month
})
.CurrentView(SchedulerViewType.Day)
.CurrentDate(new DateTime(2021, 5, 25))
.StartDayHour(9)
.EndDayHour(19)
.Height(600)
.TextExpr("Text")
.StartDateExpr("StartDate")
.EndDateExpr("EndDate")
.AllDayExpr("AllDay")
.RecurrenceRuleExpr("RecurrenceRule")
)
using DevExtreme.NETCore.Demos.Models.SampleData;
using DevExtreme.NETCore.Demos.ViewModels;
using Microsoft.AspNetCore.Mvc;
using System;
using System.Collections.Generic;
using System.Linq;
namespace DevExtreme.NETCore.Demos.Controllers {
public class SchedulerController : Controller {
public ActionResult WebAPIService() {
return View();
}
}
}
using System;
using System.Collections.Generic;
using System.Linq;
using Microsoft.AspNetCore.Mvc;
using DevExtreme.NETCore.Demos.Models;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Caching.Memory;
using DevExtreme.AspNet.Mvc;
using DevExtreme.AspNet.Data;
using Newtonsoft.Json;
namespace DevExtreme.NETCore.Demos.Controllers.ApiControllers {
[Route("api/[controller]")]
public class SchedulerDataController : Controller {
InMemoryAppointmentsDataContext _data;
public SchedulerDataController(IHttpContextAccessor httpContextAccessor, IMemoryCache memoryCache) {
_data = new InMemoryAppointmentsDataContext(httpContextAccessor, memoryCache);
}
[HttpGet]
public object Get(DataSourceLoadOptions loadOptions) {
return DataSourceLoader.Load(_data.Appointments, loadOptions);
}
[HttpPost]
public IActionResult Post(string values) {
var newAppointment = new Appointment();
JsonConvert.PopulateObject(values, newAppointment);
if(!TryValidateModel(newAppointment))
return BadRequest(ModelState.GetFullErrorMessage());
_data.Appointments.Add(newAppointment);
_data.SaveChanges();
return Ok();
}
[HttpPut]
public IActionResult Put(int key, string values) {
var appointment = _data.Appointments.First(a => a.AppointmentId == key);
JsonConvert.PopulateObject(values, appointment);
if(!TryValidateModel(appointment))
return BadRequest(ModelState.GetFullErrorMessage());
_data.SaveChanges();
return Ok();
}
[HttpDelete]
public void Delete(int key) {
var appointment = _data.Appointments.First(a => a.AppointmentId == key);
_data.Appointments.Remove(appointment);
_data.SaveChanges();
}
}
}
using System;
using System.Collections.Generic;
using System.Linq;
using Newtonsoft.Json;
namespace DevExtreme.NETCore.Demos.Models {
public class Appointment {
[JsonProperty(PropertyName = "AppointmentId")]
public int AppointmentId { get; set; }
[JsonProperty(PropertyName = "Text")]
public string Text { get; set; }
[JsonProperty(PropertyName = "Description")]
public string Description { get; set; }
[JsonProperty(PropertyName = "StartDate")]
public string StartDate { get; set; }
[JsonProperty(PropertyName = "EndDate")]
public string EndDate { get; set; }
[JsonProperty(PropertyName = "AllDay")]
public bool AllDay { get; set; }
[JsonProperty(PropertyName = "RecurrenceRule")]
public string RecurrenceRule { get; set; }
[JsonProperty(PropertyName = "RecurrenceException")]
public string RecurrenceException { get; set; }
}
public class DisableDatesAppointment {
[JsonProperty(PropertyName = "AppointmentId")]
public int AppointmentId { get; set; }
[JsonProperty(PropertyName = "Text")]
public string Text { get; set; }
[JsonProperty(PropertyName = "Description")]
public string Description { get; set; }
[JsonProperty(PropertyName = "StartDate")]
public DateTime StartDate { get; set; }
[JsonProperty(PropertyName = "EndDate")]
public DateTime EndDate { get; set; }
[JsonProperty(PropertyName = "AllDay")]
public bool AllDay { get; set; }
[JsonProperty(PropertyName = "RecurrenceRule")]
public string RecurrenceRule { get; set; }
[JsonProperty(PropertyName = "RecurrenceException")]
public string RecurrenceException { get; set; }
}
}
using System;
using System.Collections.Generic;
using System.Linq;
namespace DevExtreme.NETCore.Demos.Models.SampleData {
public partial class SampleData {
public static readonly IEnumerable<Appointment> Appointments = new[] {
new Appointment {
AppointmentId = 1,
Text = "Website Re-Design Plan",
StartDate = "2021-05-24T16:30:00.000Z",
EndDate = "2021-05-24T18:30:00.000Z"
},
new Appointment {
AppointmentId = 2,
Text = "Book Flights to San Fran for Sales Trip",
StartDate = "2021-05-24T19:00:00.000Z",
EndDate = "2021-05-24T20:00:00.000Z",
AllDay = true
},
new Appointment {
AppointmentId = 3,
Text = "Install New Router in Dev Room",
StartDate = "2021-05-24T21:30:00.000Z",
EndDate = "2021-05-24T22:30:00.000Z"
},
new Appointment {
AppointmentId = 4,
Text = "Approve Personal Computer Upgrade Plan",
StartDate = "2021-05-25T17:00:00.000Z",
EndDate = "2021-05-25T18:00:00.000Z"
},
new Appointment {
AppointmentId = 5,
Text = "Final Budget Review",
StartDate = "2021-05-25T19:00:00.000Z",
EndDate = "2021-05-25T20:35:00.000Z"
},
new Appointment {
AppointmentId = 6,
Text = "New Brochures",
StartDate = "2021-05-25T21:30:00.000Z",
EndDate = "2021-05-25T22:45:00.000Z"
},
new Appointment {
AppointmentId = 7,
Text = "Install New Database",
StartDate = "2021-05-26T16:45:00.000Z",
EndDate = "2021-05-26T18:15:00.000Z"
},
new Appointment {
AppointmentId = 8,
Text = "Approve New Online Marketing Strategy",
StartDate = "2021-05-26T19:00:00.000Z",
EndDate = "2021-05-26T21:00:00.000Z"
},
new Appointment {
AppointmentId = 9,
Text = "Upgrade Personal Computers",
StartDate = "2021-05-26T22:15:00.000Z",
EndDate = "2021-05-26T23:30:00.000Z"
},
new Appointment {
AppointmentId = 10,
Text = "Customer Workshop",
StartDate = "2021-05-27T18:00:00.000Z",
EndDate = "2021-05-27T19:00:00.000Z",
AllDay = true
},
new Appointment {
AppointmentId = 11,
Text = "Prepare 2021 Marketing Plan",
StartDate = "2021-05-27T18:00:00.000Z",
EndDate = "2021-05-27T20:30:00.000Z"
},
new Appointment {
AppointmentId = 12,
Text = "Brochure Design Review",
StartDate = "2021-05-27T21:00:00.000Z",
EndDate = "2021-05-27T22:30:00.000Z"
},
new Appointment {
AppointmentId = 13,
Text = "Create Icons for Website",
StartDate = "2021-05-28T17:00:00.000Z",
EndDate = "2021-05-28T18:30:00.000Z"
},
new Appointment {
AppointmentId = 14,
Text = "Upgrade Server Hardware",
StartDate = "2021-05-28T21:30:00.000Z",
EndDate = "2021-05-28T23:00:00.000Z"
},
new Appointment {
AppointmentId = 15,
Text = "Submit New Website Design",
StartDate = "2021-05-28T23:30:00.000Z",
EndDate = "2021-05-29T01:00:00.000Z"
},
new Appointment {
AppointmentId = 16,
Text = "Launch New Website",
StartDate = "2021-05-28T19:20:00.000Z",
EndDate = "2021-05-28T21:00:00.000Z"
}
};
}
}
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Caching.Memory;
using System;
using System.Collections.Generic;
namespace DevExtreme.NETCore.Demos.Models {
public class InMemoryAppointmentsDataContext : InMemoryDataContext<Appointment> {
public InMemoryAppointmentsDataContext(IHttpContextAccessor contextAccessor, IMemoryCache memoryCache)
: base(contextAccessor, memoryCache) {
}
public ICollection<Appointment> Appointments => ItemsInternal;
protected override IEnumerable<Appointment> Source => SampleData.SampleData.Appointments;
protected override int GetKey(Appointment item) => item.AppointmentId;
protected override void SetKey(Appointment item, int key) => item.AppointmentId = key;
}
}