Simple post to Web Api

by

It’s been quite sometime since I asked this question. Now I understand it more clearly, I’m going to put a more complete answer to help others.

In Web API, it’s very simple to remember how parameter binding is happening.

  • if you POST simple types, Web API tries to bind it from the URL

  • if you POST complex type, Web API tries to bind it from the body of
    the request (this uses a media-type formatter).

  • If you want to bind a complex type from the URL, you’ll use [FromUri] in your action parameter. The limitation of this is down to how long your data going to be and if it exceeds the url character limit.

    public IHttpActionResult Put([FromUri] ViewModel data) { ... }

  • If you want to bind a simple type from the request body, you’ll use [FromBody] in your action parameter.

    public IHttpActionResult Put([FromBody] string name) { ... }

as a side note, say you are making a PUT request (just a string) to update something. If you decide not to append it to the URL and pass as a complex type with just one property in the model, then the data parameter in jQuery ajax will look something like below. The object you pass to data parameter has only one property with empty property name.

var myName="ABC";
$.ajax({url:.., data: {'': myName}});

and your web api action will look something like below.

public IHttpActionResult Put([FromBody] string name){ ... }

This asp.net page explains it all.
http://www.asp.net/web-api/overview/formats-and-model-binding/parameter-binding-in-aspnet-web-api

More Related Contents:

  1. How do I set a cookie on HttpClient’s HttpRequestMessage
  2. Dot character ‘.’ in MVC Web API 2 for request such as api/people/STAFF.45287
  3. Logging request/response messages when using HttpClient
  4. How to update a claim in ASP.NET Identity?
  5. WebAPI StreamContent vs PushStreamContent
  6. How to put conditional Required Attribute into class property to work with WEB API?
  7. Reading FromUri and FromBody at the same time
  8. Return HTML from ASP.NET Web API
  9. Using WebSockets with ASP.NET Web API
  10. Return Json, but it includes backward slashes “\”, which I don’t want
  11. What’s the difference between WCF Web API and ASP.NET Web API
  12. How to add and get Header values in WebApi
  13. Web API in MVC solution in separate project
  14. jQuery posts null instead of JSON to ASP.NET Web API
  15. MVC Form not able to post List of objects
  16. Add data annotations to a class generated by entity framework
  17. How to read request body in an asp.net core webapi controller?
  18. Circular reference detected exception while serializing object to JSON
  19. Entity framework self referencing loop detected [duplicate]
  20. How does MVC 4 List Model Binding work?
  21. Routing with multiple Get methods in ASP.NET Web API
  22. ASP.NET WebApi: how to perform a multipart post with file upload using WebApi HttpClient
  23. Return content with IHttpActionResult for non-OK response
  24. How to throttle requests in a Web Api?
  25. Post byte array to Web API server using HttpClient
  26. how to create an audit trail with Entity framework 5 and MVC 4
  27. How to configure Swashbuckle to ignore property on model
  28. Web Api Request Content is empty in action filter
  29. Disable *all* exception handling in ASP.NET Web API 2 (to make room for my own)?
  30. How to simulate browser HTTP POST request and capture result in C#

Leave a Comment