MVC WebApi Get passing an object in C#

Question

I need to get a from and to date to my mvc webapi for retrieving items between those dates. Here is my favorite thing I have tried that has not worked (I have tried several things).

I have an object that is shared between the projects:

public class SchedulerDateSpan
{
    public DateTime StartDate { get; set; }
    public DateTime EndDate { get; set; }
}

Here is my controller class for get:

public IEnumerable<Appointment> GetAppointments(SchedulerDateSpan dates)
{
   IEnumerable<Appointment> appointments =
   db.Appointments.Where(
   a =>
   (a.StartDate <= dates.StartDate && a.EndDate >= dates.StartDate) || (a.StartDate <= dates.EndDate && a.EndDate >= dates.EndDate) ||
   (a.StartDate > dates.StartDate && a.EndDate < dates.EndDate)).AsEnumerable();
   return appointments;
}

Here is my call from the client where dates is of type SchedulerDateSpan:

var client = new HttpClient { BaseAddress = new Uri(Properties.Settings.Default.SchedulerWebApi) };

client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

HttpResponseMessage resp = client.GetAsync(String.Format("api/Appointments/{0}",dates)).Result;

if (resp.IsSuccessStatusCode)
{ 
   var appointments = resp.Content.ReadAsAsync<IEnumerable<Appointment>>().Result;
          ......
}

I also tried changing it to a put which seemed to work but then I couldn't parse the results with Content.ReadAsAsync

Any suggestions are appreciated

Maggie Ying · Accepted Answer · 2012-11-27 21:20:29Z

7

By default, complex type (such as your SchedulerDateSpan) are expected to be passed in the request body. You'll have to change mark the action parameter to be [FromUri] if you want the value to be passed from the URI:

public IEnumerable<Appointment> GetAppointments([FromUri]SchedulerDateSpan dates)
{...}

You can then pass the 'dates' from the query string in the Uri, like this:

HttpResponseMessage resp = client.GetAsync(
  String.Format("api/Appointments?dates.StartDate={0}&dates.EndDate={1}", 
    dates.StartDate.ToString(),
    dates.EndDate.ToString())).Result;

answered Nov 27, 2012 at 21:20

Maggie Ying

10.2k2 gold badges37 silver badges37 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Teresa Burger Over a year ago

Worked like a champ! Thank you!!

tcarvin · Accepted Answer · 2012-11-27 21:25:14Z

4

If you are trying to pass a complex object via the query string then you need to decorate your Get method parameter with the [FromUri] attribute:

public IEnumerable<Appointment> GetAppointments([FromUri] SchedulerDateSpan dates)

Your query string would look something like this:

http://server.com/api/Appointments?StartDate=blah1&EndDate=blah2

Good luck!

edited Nov 27, 2012 at 21:25

answered Nov 27, 2012 at 21:18

tcarvin

10.9k3 gold badges33 silver badges53 bronze badges

Collectives™ on Stack Overflow

MVC WebApi Get passing an object in C#

2 Answers 2

1 Comment

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Linked

Related