Dates without time in ASP.NET Web API's JSON output

Question

Is there a simple way to configure JSON.NET so that some DateTime fields will be formatted without time and other DateTime fields will still be formatted with time?

Example:

{ firstName: 'John', lastName : 'Doe', birthday: '1965-09-23' }

score 73 · Accepted Answer · answered May 01 '13 at 19:15

73

If you need this to only affect a particular field, create a converter type first:

public class OnlyDateConverter : IsoDateTimeConverter
{
    public OnlyDateConverter()
    {
        DateTimeFormat = "yyyy-MM-dd";
    }
}

and then add this attribute to whatever fields/properties you want this for:

[JsonConverter(typeof(OnlyDateConverter))]

answered May 01 '13 at 19:15

Youssef Moussaoui

12,187
2
41
37

Nice. I was just getting to write the same thing, but extending `DateTimeConverterBase`. This is much cleaner! – Matt Johnson-Pint May 01 '13 at 19:27
Apparently you should use `/` instead of dashes for the benefit of certain old browsers : http://blog.dygraphs.com/2012/03/javascript-and-dates-what-mess.html – Simon_Weaver Jul 20 '14 at 06:54
Should you make the property as a DateTime or as a string? – Stephen Lautier Oct 31 '14 at 18:12
1

You can also use predefined `Microsoft.Rest.Serialization.DateJsonConverter` type from `Microsoft.Rest.ClientRuntime` package (it is installed together with `Microsoft.AspNetCore.All` package) – whyleee Sep 30 '17 at 14:34
Great solution, searched a lot to try to find. Thanks – CodingRiot Jan 16 '18 at 14:40
@whyleee how would you use that one instead? – James L. Jun 20 '19 at 16:51
2

This did not work for me, I am still getting the time sent even if I decorate a model's property with this attribute. – James L. Jun 20 '19 at 19:05

score 5 · Answer 2 · answered May 01 '13 at 18:39

5

Try adding this line to configure your Web API:

config.Formatters.JsonFormatter.SerializerSettings.Converters.Add(
    new IsoDateTimeConverter() { DateTimeFormat = "yyyy-MM-dd" });

answered May 01 '13 at 18:39

Youssef Moussaoui

12,187
2
41
37

9

That would have effect globally, not just on "some" fields, as requested. – Matt Johnson-Pint May 01 '13 at 18:59

score 0 · Answer 3 · answered May 01 '13 at 19:26

Yousesef's answer with the OnlyDateConverter is best. But here is one alternative:

private DateTime _birthday;
public string Birthday
{
    get { return _birthday.ToString("yyyy-MM-dd"); }
    set {
          _birthday = DateTime.ParseExact(value, "yyyy-MM-dd",
                                          CultureInfo.InvariantCulture);
        }
}

Advantage - You don't need to bind the Newtonsoft.Json library to your classes.

Disadvantage - The property is now exposed as a string anywhere you use it, which can cause it's own set of problems.

I've considered that approach, but it may not be the best when computations could be involved between dates. Thanks anyways! — RooSoft, May 03 '13 at 19:11

Dates without time in ASP.NET Web API's JSON output

3 Answers3

Linked