Web api 2 same method name and same parameter name

Question

I have two methods in my api controller with same name and same number of parameters but the type of one of the parameter is different. You can see here

[HttpGet]
public dynamic Add(String organizationId, Driving driving)

[HttpGet]
public dynamic Add(String organizationId, bool driving)

I am trying to call the api like this

var data {organizationId: "something", driving: true };

var ajaxConfig = {
        url: some url,
        type: "GET",
        dataType: 'json',
        crossDomain: true,
        success: function (data) {
            onDone();
            callback(data);
        },
        error: function (error, textStatus, errorThrown) {
        }

      };
        ajaxConfig.data = data;

    $.ajax(ajaxConfig);

The system gets confused between which api to call. Am I doing it wrong? Is there some other way to do it?

I would keep the routes different. But you can try giving route constraints '[Route("Add/{organizationId}/{driving:bool}")]' for the second method. Not sure whether this works, I've never tried — Developer
– Developer, Commented Apr 21, 2017 at 7:00

Marcus Höglund · Accepted Answer · 2017-04-21 06:58:00Z

3

You could use attribute routing to make the methods point to different routes in the controller

[HttpGet]
[Route("api/controller/add1")] // Url http://url.domain.com/api/controller/add1
public dynamic Add(String organizationId, Driving driving)

[HttpGet]
[Route("api/controller/add2")] // Url http://url.domain.com/api/controller/add2
public dynamic Add(String organizationId, bool driving)

edited Apr 21, 2017 at 6:58

answered Apr 21, 2017 at 6:55

Marcus Höglund

16.9k11 gold badges53 silver badges72 bronze badges

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

3 Comments

Webbanditten Over a year ago

Exactly my thoughts.

mohsinali1317 Over a year ago

But then while calling them from client would the url be "somthing/Add" or "something/method1 etc?"

Marcus Höglund Over a year ago

@ChaudhryMohsinAli updated the question. From client you call it "api/controller/add1"

John Verbiest · Accepted Answer · 2017-04-21 07:09:12Z

The controller can only make the difference between two identically named methods in two ways:

Via HttpVerb attributes: In this case you could apply [HttpGet] to the first method and [HttpPost] to the second. When calling from a client you must use the Get method when using the first one and the Post method when using the second one.
Via Route attribute: In this case you tell MVC what route to take for each method (ex: [Route("api/mycontroller/AddWithBoolean")] ). In this case the client chooses the correct method by using the correct route.

In case you dont want to make the distinction in the client and you want your server to do the distinction you need another approach.

You can create a method like this:

[HttpGet]
public dynamic Add(String organizationId, object driving)
{
     if (driving is Driving)
          // execute code
     else
          // execute other code
}

This example is far from complete but it could be an approach.

With regards, John

Collectives™ on Stack Overflow

Web api 2 same method name and same parameter name

2 Answers 2

3 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related