How to pass DateTime parameter using Web API attribute routing?

Question

I am working on a REST API with ASP.NET Web API 2. Thing get bad when I try to integrate dates into the game.

Here is the route:

[Route("{id:Guid}/{from:DateTime}/{to:DateTime}")]

When I do that I can perfectly pass something like

.../[id]/2012-01-01/2013-01-01

However, when I get to the point where I need the time information it gets quite bad, let's imagine this one:

.../[id]/2012-01-01/2013-01-01 1:45:30 PM/2013-01-01 1:45:30 PM

It seems like the spaces are going OK but the ":" are blocking. So I though I should use my own format, being yyyyMMddhhmm. This gives the following URL:

.../[id]/201301031147/201401031147

However, .NET is not expecting this as a DateTime and does not know how to use it. So I used a IHttpRouteConstraint to allow it. The problem is that it still does not know how to deal with it after I told it it's fine...

So my question is, how do you pass a DateTime to the route?

Did you try to encode your request url? For instance, if you encode this string 2013-01-01 1:45:30 PM/2013-01-01 1:45:30 PM you will get this one 2013-01-01%201%3A45%3A30%20PM%2F2013-01-01%201%3A45%3A30%20PM — Thomas C. G. de Vilhena
– Thomas C. G. de Vilhena, Commented Jan 3, 2014 at 12:18
Hello, thanks for the reply! I actually use RestSharp on the client side and it does that automatically. — Georges
– Georges, Commented Jan 3, 2014 at 12:30
All right. What about making your date string compatible with The Universal Sortable Format. Could you check if that works? Here is a sample date string represented in that format: 2008-04-10 13:30:00Z — Thomas C. G. de Vilhena
– Thomas C. G. de Vilhena, Commented Jan 3, 2014 at 12:49
Thanks again! I tried u, o and s formats described in msdn ( msdn.microsoft.com/fr-fr/library/zdtaw1bw(v=vs.110).aspx ) The one you're refeering to is u. No luck this way either sadly... I think there must be a place to tell the framework which format to use or something like that. Or at least a way to take that data and transform it myself into a DateTime — Georges
– Georges, Commented Jan 3, 2014 at 12:57
One approach to overcome this problem is to convert the datetime object to UTC at the client, and back to datetime from UTC in the webapi. — LakshmiNarayanan
– LakshmiNarayanan, Commented Mar 28, 2014 at 11:45

Geoff Cox · Accepted Answer · 2015-08-18 03:17:56Z

4

The problem is that : is a URL reserved character in the path. MVC doesn't expect it to be URL encoded and won't handle it. However, it is not reserved in the query string.

Remove it from your routing specification, but leave them as parameters in your method and the model binder will bind them. Alternatively, you can also remove them as parameters and access them via the Context query string property or ControllerContext.Request.GetQueryNameValuePairs().

So you would have ?fromDate=2012-01-01T1:45:30PM&toDate=2013-01-01T1:45:30PM

edited Aug 18, 2015 at 3:17

answered Aug 18, 2015 at 3:12

Geoff Cox

6,1522 gold badges31 silver badges30 bronze badges

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

Collectives™ on Stack Overflow

How to pass DateTime parameter using Web API attribute routing?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related