ASP.NET WebAPI passing empty string in urlencoded body as null

Question

I have a simple ApiController

public HttpResponseMessage Put(int orderid, [FromBody] Order order)
{
    // Do something useful with order.Notes here
}

and a class (the actual class contains several more properties)

public class Order
{
    public string Notes { get; set; }
}

and wish to handle PUT requests of the following type

PUT http://localhost/api/orders/{orderid}
Content-Type: application/x-www-form-urlencoded

notes=sometext

Everything works fine, but empty values are passed as null

notes=blah            // passes blah
notes=                // Passes null
someothervalue=blah   // Passes null

Is it possible to have ApiController distinguish between empty values and missing values?

Did you by any chance find a solution to this? – Michael Norgren Jan 29 '13 at 15:33 — Michael Norgren, Jan 29 '13 at 15:33

score 3 · Accepted Answer · answered Jan 30 '13 at 18:06

3

Have you tried annotating the property with DisplayFormatAttribute, like,

public class Order
{
    [DisplayFormat(ConvertEmptyStringToNull=false)]
    public string Notes { get; set; }
}

answered Jan 30 '13 at 18:06

RaghuRam Nadiminti

6,718
1
33
30

This worked as perfectly. Rembember to add a reference to Assembly: **System.ComponentModel.DataAnnotations (in System.ComponentModel.DataAnnotations.dll)** and import the namespace. For full documentation see [link](http://msdn.microsoft.com/en-us/library/system.componentmodel.dataannotations.displayformatattribute.convertemptystringtonull(v=vs.100).aspx) – Gomu Miyashita Jan 31 '13 at 13:04

score 2 · Answer 2 · edited May 23 '17 at 12:31

The root of this comes from the ReplaceEmptyStringWithNull that calls string.IsNullOrWhiteSpace instead of string.IsNullOrEmpty

To fix this across your entire WebAPI project, you need to swap out the ModelMetadataProvider with one that sets the ConvertEmptyStringToNull to false

See Set default for DisplayFormatAttribute.ConvertEmptyStringToNull to false

This was actually "fixed" in v6 - see https://github.com/aspnet/Mvc/issues/3593

ASP.NET WebAPI passing empty string in urlencoded body as null

2 Answers2

Linked