Multiple HttpPost method in Web API controller

Question

I am starting to use MVC4 Web API project  I have controller with multiple HttpPost methods  The Controller looks like the following   Controller  public class VTRoutingController   ApiController        HttpPost      public MyResult Route MyRequestTemplate routingRequestTemplate                return null              HttpPost      public MyResult TSPRoute MyRequestTemplate routingRequestTemplate                return null            Here MyRequestTemplate represents the template class responsible for handling the Json coming through the request    Error   When I make a request using Fiddler for http   localhost 52370 api VTRouting TSPRoute or http   localhost 52370 api VTRouting Route  I get an error       Multiple actions were found that match the request   If I remove one of the above method it works fine   Global asax  I have tried modifying the default routing table in global asax  but I am still getting the error  I think I have problem in defining routes in global asax  Here is what I am doing in global asax    public static void RegisterRoutes RouteCollection routes        routes MapHttpRoute          name   MyTSPRoute           routeTemplate   api VTRouting TSPRoute           defaults  new                 routes MapHttpRoute          name   MyRoute           routeTemplate   api VTRouting Route           defaults  new   action  Route               I am making the request in Fiddler using POST  passing json in RequestBody for MyRequestTemplate

User · Answer

Best and simplest explanation I have seen on this topic - http://www.binaryintellect.net/articles/9db02aa1-c193-421e-94d0-926e440ed297.aspx

Edited -

I got it working with only Route, and did not need RoutePrefix.

For example, in the controller

[HttpPost]
[Route("[action]")]
public IActionResult PostCustomer
([FromBody]CustomerOrder obj)
{
}

and

[HttpPost]
[Route("[action]")]
public IActionResult PostCustomerAndOrder
([FromBody]CustomerOrder obj)
{
}

Then, the function name goes in jquery as either -

options.url = "/api/customer/PostCustomer";

or

options.url = "/api/customer/PostCustomerAndOrder";

User · Answer

A web api endpoint  controller  is a single resource that accepts get post put delete verbs   It is not a normal MVC controller   Necessarily  at  api VTRouting there can only be one HttpPost method that accepts the parameters you are sending   The function name does not matter  as long as you are decorating with the  http  stuff   I ve never tried  though   Edit   This does not work   In resolving  it seems to go by the number of parameters  not trying to model-bind to the type     You can overload the functions to accept different parameters   I am pretty sure you would be OK if you declared it the way you do  but used different  incompatible  parameters to the methods   If the params are the same  you are out of luck as model binding won t know which one you meant     HttpPost  public MyResult Route MyRequestTemplate routingRequestTemplate          HttpPost  public MyResult TSPRoute MyOtherTemplate routingRequestTemplate          This part works  The default template they give when you create a new one makes this pretty explicit  and I would say you should stick with this convention   public class ValuesController   ApiController          GET is overloaded here   one method takes a param  the other not         GET api values       public IEnumerable lt string gt  Get        return new string                GET api values 5     public string Get int id    return  hi there             POST api values  OVERLOADED      public void Post string value              public void Post string value  string anotherValue                 PUT api values 5     public void Put int id  string value            DELETE api values 5     public void Delete int id         If you want to make one class that does many things  for ajax use  there is no big reason to not use a standard controller action pattern   The only real difference is your method signatures aren t as pretty  and you have to wrap things in Json  returnValue  before you return them   Edit   Overloading works just fine when using the standard template  edited to include  when using simple types   I ve gone and tested the other way too  with 2 custom objects with different signatures   Never could get it to work    Binding with complex objects doesn t look  deep   so thats a no-go You could get around this by passing an extra param  on the query string A better writeup than I can give on available options   This worked for me in this case  see where it gets you   Exception for testing only   public class NerdyController   ApiController       public void Post string type  Obj o             throw new Exception  Type     type      o Name     o Name              public class Obj       public string Name   get  set        public string Age   get  set        And called like this form the console     post   api Nerdy type white      Name   Slim    Age   21

User · Answer

use   routes MapHttpRoute      name   DefaultApi       routeTemplate   api  controller   action   id        defaults  new   id   RouteParameter Optional        it s not a RESTful approach anymore  but you can now call your actions by name  rather than let the Web API automatically determine one for you based on the verb  like this    POST   api VTRouting TSPRoute   POST   api VTRouting Route   Contrary to popular belief  there is nothing wrong with this approach  and it s not abusing Web API  You can still leverage on all the awesome features of Web API  delegating handlers  content negotiation  mediatypeformatters and so on  - you just ditch the RESTful approach

User · Answer

Put Route Prefix  RoutePrefix  api Profiles    at the controller level and put a route at action method  Route  LikeProfile     Don t need to change anything in global asax file  namespace KhandalVipra Controllers        RoutePrefix  api Profiles        public class ProfilesController   ApiController                  POST  api Profiles LikeProfile          Authorize           HttpPost           Route  LikeProfile             ResponseType typeof List lt Like gt             public async Task lt IHttpActionResult gt  LikeProfile

User · Answer

I think the question has already been answered  I was also looking for something a webApi controller that has same signatured mehtods but different names  I was trying to implement the Calculator as WebApi  Calculator has 4 methods with the same signature but different names    public class CalculatorController   ApiController        HttpGet       ActionName  Add        public string Add int num1   1  int num2   1  int timeDelay   1                Thread Sleep 1000   timeDelay           return string Format  Add    0    num1   num2               HttpGet       ActionName  Sub        public string Sub int num1   1  int num2   1  int timeDelay   1                Thread Sleep 1000   timeDelay           return string Format  Subtract result    0    num1 - num2               HttpGet       ActionName  Mul        public string Mul int num1   1  int num2   1  int timeDelay   1                Thread Sleep 1000   timeDelay           return string Format  Multiplication result    0    num1   num2               HttpGet       ActionName  Div        public string Div int num1   1  int num2   1  int timeDelay   1                Thread Sleep 1000   timeDelay           return string Format  Division result    0    num1   num2             and in the WebApiConfig file you already have    config Routes MapHttpRoute              name   DefaultApi               routeTemplate   api  controller   action   id                defaults  new   id   RouteParameter Optional       Just set the authentication   authorisation on IIS and you are done   Hope this helps

User · Answer

public class Journal   ApiController       public MyResult Get journal id                return null           public class Journal   ApiController        public MyResult Get journal id  publication id                return null            I am not sure whether overloading get post  method violates the concept of  restfull api but it workds   If anyone could ve enlighten on this matter   What if  I have a uri as   uri  api journal journalid uri  api journal journalid publicationid   so as you might seen my journal sort of aggregateroot  though i can define another controller for publication solely and pass id number of publication in my url however this gives much more sense  since my publication would not exist without journal itself

User · Answer

You can use this approach   public class VTRoutingController   ApiController        HttpPost  quot Route quot        public MyResult Route MyRequestTemplate routingRequestTemplate                return null              HttpPost  quot TSPRoute quot        public MyResult TSPRoute MyRequestTemplate routingRequestTemplate                return null

User · Answer

You can have multiple actions in a single controller   For that you have to do the following two things    First decorate actions with ActionName attribute like     ActionName  route     public class VTRoutingController   ApiController        ActionName  route       public MyResult PostRoute MyRequestTemplate routingRequestTemplate            return null           ActionName  tspRoute      public MyResult PostTSPRoute MyRequestTemplate routingRequestTemplate           return null         Second define the following routes in WebApiConfig file      Controller Only    To handle routes like   api VTRouting  config Routes MapHttpRoute      name   ControllerOnly       routeTemplate   api  controller                          Controller with ID    To handle routes like   api VTRouting 1  config Routes MapHttpRoute      name   ControllerAndId       routeTemplate   api  controller   id        defaults  null      constraints  new   id       d         Only integers         Controllers with Actions    To handle routes like   api VTRouting route  config Routes MapHttpRoute      name   ControllerAndAction       routeTemplate   api  controller   action

User · Answer

It is Possible to add Multiple Get and Post methods in the same Web API Controller  Here default Route is Causing the Issue  Web API checks for Matching Route from Top to Bottom and Hence Your Default Route Matches for all Requests  As per default route only one Get and Post Method is possible in one controller  Either place the following code on top or Comment Out Delete Default Route      config Routes MapHttpRoute  API Default                                    api  controller   action   id                                   new   id   RouteParameter Optional

User · Answer

A much better solution to your problem would be to use Route which lets you specify the route on the method by annotation    RoutePrefix  api VTRouting    public class VTRoutingController   ApiController        HttpPost       Route  Route        public MyResult Route MyRequestTemplate routingRequestTemplate                return null              HttpPost       Route  TSPRoute        public MyResult TSPRoute MyRequestTemplate routingRequestTemplate                return null

[c#] Multiple HttpPost method in Web API controller

Examples related to c#

Examples related to asp.net-web-api

Examples related to global-asax

Examples related to asp.net-web-api-routing