ASP.NET MVC and Web API model binding - how do I bind to properties with names disallowed by the language?

Question

An example of basic model binding to an object in ASP.NET MVC or the ASP.NET Web API might look like this (using C# as example):

public class MyModel
{
    public string value1 { get; set; } 
    public string value2 { get; set; }
}

public ValuesController : ApiController
{
    public HttpResponseMessage Post(MyModel model) { ... }
}

As long as the POST body looks like value1=somevalue&value2=someothervalue things map just fine.

But how do I handle a scenario where the post body contains parameter names that are disallowed as class property names, such as body-text=bla&...?

@artm Because that's what the service that is sending me a webhook is naming one of their parameters. It's an email service so they are referring the body of an email. It's just a name, it could be "foo-bar". The "body" in "body-text" has nothing to do with a post body. — Robert
– Robert, Commented Jun 16, 2015 at 15:31
possible duplicate of ASP.NET MVC Model Binding with Dashes in Form Element Names — Becuzz
– Becuzz, Commented Jun 16, 2015 at 19:35
Also, this might be worth looking at http://stackoverflow.com/questions/3461365/using-a-dash-in-asp-mvc-parameters — Becuzz
– Becuzz, Commented Jun 16, 2015 at 19:36

peinearydevelopment · Accepted Answer · 2015-06-16 15:28:02Z

1

You should be able to utilize data serialization attributes to help you with this:

[DataContract]
public class MyModel
{
    [DataMember(Name = "body-text")]
    public string value1 { get; set; } 
    public string value2 { get; set; }
}

answered Jun 16, 2015 at 15:28

peinearydevelopment

11.5k5 gold badges52 silver badges82 bronze badges

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

1 Comment

Robert Over a year ago

Whichever property I stick the attribute on comes up as null. I used your model example and sent the following post body body-text=mybodytext&value2=bla. value1 was null and value2 was "bla".

Ben Wilde · Accepted Answer · 2016-08-15 22:18:13Z

1

You can force Asp.Net to use the Newtonsoft.JSON deserializer by passing a JObject to your action, although it is a bit annoying to have to do it like this.

Then you can work with it as a JObject or call .ToObject<T>(); which will then honor the JsonProperty attribute.

// POST api/values
public IHttpActionResult Post(JObject content)
{
    var test = content.ToObject<MyModel>();
    // now you have your object with the properties filled according to JsonProperty attributes.
    return Ok();
}

MyModel example:

 public class MyModel
 {
     [JsonProperty(Name = "body-text")]
     public string value1 { get; set; } 

     public string value2 { get; set; }
 }

answered Aug 15, 2016 at 22:18

Ben Wilde

5,7023 gold badges43 silver badges36 bronze badges

Collectives™ on Stack Overflow

ASP.NET MVC and Web API model binding - how do I bind to properties with names disallowed by the language?

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