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
– Michael Norgren

2013-01-29 15:33:57 +00:00
Commented Jan 29, 2013 at 15:33 — Michael Norgren
– Michael Norgren, Commented Jan 29, 2013 at 15:33

RaghuRam Nadiminti · Accepted Answer · 2013-01-30 18:06:14Z

3

Have you tried annotating the property with DisplayFormatAttribute, like,

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

answered Jan 30, 2013 at 18:06

RaghuRam Nadiminti

6,8131 gold badge35 silver badges30 bronze badges

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

1 Comment

Gomu Miyashita Over a year ago

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

Community · Accepted Answer · 2017-05-23 12:31:17Z

2

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

edited May 23, 2017 at 12:31

CommunityBot

11 silver badge

answered Apr 11, 2016 at 20:04

Brett Veenstra

48.7k18 gold badges73 silver badges87 bronze badges

Collectives™ on Stack Overflow

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

2 Answers 2

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related