Passing UTC DateTime to Web API HttpGet Method results in local time

Question

I'm trying to pass a UTC date as a query string parameter to a Web API method. The URL looks like

/api/order?endDate=2014-04-01T00:00:00Z&zoneId=4

The signature of the method looks like

[HttpGet]
public object Index(int zoneId, DateTime? endDate = null)

The date is coming in as 31/03/2014 8:00:00 PM but I'd like it to come in as 01/04/2014 12:00:00 AM

My JsonFormatter.SerializerSettings looks like this

new JsonSerializerSettings
{
    ContractResolver = new CamelCasePropertyNamesContractResolver(),
    DateTimeZoneHandling = DateTimeZoneHandling.Utc,
    DateFormatHandling = DateFormatHandling.IsoDateFormat
};

EDIT #1: I've noticed when I POST 2014-04-01T00:00:00Z it will serialize to the UTC DateTime kind in C#. However I've found a work around of doing endDate.Value.ToUniversalTime() to convert it although I find it odd how it works for a POST but not a GET.

Solution 1

The query string parameter value you are sending 2014-04-01T00:00:00Z is UTC time. So, the same gets translated to a time based on your local clock and if you call ToUniversalTime(), it gets converted back to UTC.

So, what exactly is the question? If the question is why is this happening if sent in as query string but not when posted in request body, the answer to that question is that ASP.NET Web API binds the URI path, query string, etc using model binding and the body using parameter binding. For latter, it uses a media formatter. If you send JSON, the JSON media formatter is used and it is based on JSON.NET.

Since you have specified DateTimeZoneHandling.Utc, it uses that setting and you get the date time kind you want. BTW, if you change this setting to DateTimeZoneHandling.Local, then you will see the same behavior as model binding.

Solution 2

If you want the conversion to be transparent, then you could use a custom TypeConverter:

public sealed class UtcDateTimeConverter : DateTimeConverter
{
    public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
    {
        return ((DateTime)base.ConvertFrom(context, culture, value)).ToUniversalTime();
    }
}

and wire it up using:

TypeDescriptor.AddAttributes(typeof(DateTime), new TypeConverterAttribute(typeof(UtcDateTimeConverter)));

Then the query string parameter will be instantiated as DateTimeKind.Utc.

Solution 3

I ended up just using the ToUniversalTime() method as parameters come in.

Solution 4

So, for those of you who do not wish to override string-to-date conversion in your entire application, and also don't want to have to remember to modify every method that takes a date parameter, here's how you do it for a Web API project.

Ultimately, the general instructions come from here:

https://docs.microsoft.com/en-us/aspnet/web-api/overview/formats-and-model-binding/parameter-binding-in-aspnet-web-api#model-binders

Here's the specialized instructions for this case:

1. In your "WebApiConfig" class, add the following:

       var provider = new SimpleModelBinderProvider(typeof(DateTime),new UtcDateTimeModelBinder());
       config.Services.Insert(typeof(ModelBinderProvider), 0, provider);
   

2. Create a new class called UtcDateTimeModelBinder:

   public class UtcDateTimeModelBinder : IModelBinder
   {
       public bool BindModel(HttpActionContext actionContext,
           ModelBindingContext bindingContext)
       {
           if (bindingContext.ModelType != typeof(DateTime)) return false;
   
           var val = bindingContext.ValueProvider.GetValue(bindingContext.ModelName);
           if (val == null)
           {
               return false;
           }
   
           var key = val.RawValue as string;
           if (key == null)
           {
               bindingContext.ModelState.AddModelError(bindingContext.ModelName,
                   "Wrong value type");
               return false;
           }
   
           DateTime result;
           if (DateTime.TryParse(key, out result))
           {
               bindingContext.Model = result.ToUniversalTime();
               return true;
           }
   
           bindingContext.ModelState.AddModelError(bindingContext.ModelName,
               "Cannot convert value to Utc DateTime");
           return false;
       }
   }
   

View more solutions

Comments

[Ryan]

So I guess the correct thing to do is leave it the way it is and continue to convert the querystring dates back to UTC with the work around I have? What's the best approach?

[Sean Fausett]

See blogs.msdn.com/b/jmstall/archive/2012/04/20/… for more information.

[Richard]

This should be the answer, it's a very clear description of exactly what is happening.

[MRP]

I had the same problem and none of the answers was my real answer and I ended up with your answer or add custom model binder and add [ModelBinder(typeof(UtcDateTimeModelBinder))] to every parameter you want

[MRP]

is there any solution to add this UtcDateTimeConverter to Register method of startup.cs class in web api ? I couldn't raise up your class

[CSCoder]

This should not be the answer. Although it explains what is going on it doesn't provide a solution to the question. The OP stated that they want the time to come in as UTC not for it to come in as local and convert to UTC. If this is not possible your answer does not make that clear, if it is you don't say how this can be achieved. I have the same question. I don't want to be calling ToUniversalTime() every time I receive a date. I would like to just receive the UTC time. Is there some deserialization setting somewhere that will do this automatically?

[Peter L]

This does not work when dealing with DateTime in the Controller. See example code

[Brain2000]

I added this to the lambda GlobalConfiguration.Configure(config => TypeDescription.AddAttributes(..... and it worked beautifully! Thank you Sean!