Web API route for different parameter types

Question

Trying to get my head around Web API routing.

I have the following two controllers which have different methods/actions

 public class MerchantController : ApiController
    {
        [HttpGet]
        [ActionName("GetSuggestedMerchants")]
        public IEnumerable<Merchant> GetSuggestedMerchants(string name)
        {
           ....

and

    public class PortalMerchantController : ApiController
    {
        [HttpGet]
        [ActionName("GetNPortalMerchants")]
        public IEnumerable<PortalMerchantDto> GetNPortalMerchants(int id)
        {
          ...

And I have these two routes mapped:

        config.Routes.MapHttpRoute(
           name: "ActionApi",
            routeTemplate: "api/{controller}/{action}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );
        config.Routes.MapHttpRoute(
         name: "ActionApiTwoParams",
          routeTemplate: "api/{controller}/{action}/{name}"
          );

Calling

$http.get("api/PortalMerchant/GetNPortalMerchants/26")

works fine but calling

$http.get("api/Merchant/GetSuggestedMerchants/SomeName")

does not get routed and fails with:

{"Message":"No HTTP resource was found that matches the request URI 'http://localhost:2769/api/Merchant/GetSuggestedMerchants/SomeName'.","MessageDetail":"No action was found on the controller 'Merchant' that matches the request."}

I figured I needed two roots because the parameter name and type is different for the two methods. Can anyone suggest why the second one does not get routed?

I guess it must be using the first route $http.get("api/Merchant/GetSuggestedMerchants/SomeName") which would explain why no action was found on the Merchant controller (as there is no method which takes an ID parameter) but why would it use the first route and not the second when the parameter names are specified? — Dan Cook
– Dan Cook, Commented Dec 1, 2013 at 1:41

Sam Axe · Accepted Answer · 2013-12-01 01:46:26Z

2

Routing take the first route that matches the URL.

Your URLs do not contain named parameters.. just parameter values.

You need to define stricter routeTemplates. Like:

    config.Routes.MapHttpRoute(
     name: "PortalMerchantAPI",
      routeTemplate: "api/PortalMerchant/{action}/{name}"
      );
    config.Routes.MapHttpRoute(
     name: "MerchantAPI",
      routeTemplate: "api/Merchant/{action}/{id}"
        defaults: new { id = RouteParameter.Optional }
      );
    config.Routes.MapHttpRoute(
       name: "DefaultApi",
        routeTemplate: "api/{controller}/{action}/{id}",
        defaults: new { id = RouteParameter.Optional }
    );

The order of the routes matters

answered Dec 1, 2013 at 1:46

Sam Axe

33.9k10 gold badges60 silver badges92 bronze badges

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

1 Comment

Mike Wasson Over a year ago

You might also look at attribute routing for this scenario.

Collectives™ on Stack Overflow

Web API route for different parameter types

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related