Web-API controller multiple GET int and string parameters

Question

I would like to have a controller with multiple GET, one for all, one with int parameter and the other with a string parameter. The following example still give me error:

[ApiController]
[Route("[controller]")]
public class StudentsController : ControllerBase
{
    [HttpGet]
    public IEnumerable<Student> Get()
    {
        return GetStudents();
    }

    [HttpGet("{id}")]
    public Student Get(int id)
    {
        return GetStudents().FirstOrDefault(s=> s.id == id);
    }

    [HttpGet("{name}")]
    public Student Get(string name)
    {
        return GetStudents().FirstOrDefault(s=> s.name == name);
    }
}

EDIT Current I get the following error

what error do you get, please specify?

JSteward
– JSteward

2020-11-12 19:05:26 +00:00
Commented Nov 12, 2020 at 19:05 — JSteward
– JSteward, Commented Nov 12, 2020 at 19:05

Tazz · Accepted Answer · 2020-11-12 19:22:18Z

5

The int and string are treated equivalently in the url so it can't differentiate between the methods. You would need to either to have an additional part of the route, for example [HttpGet("id/{id}")] and [HttpGet("name/{name}")], or use query strings.

Alternatively you can have a single method and try parse the parameter into an int, if it succeeds, then retrieve by id, otherwise retrieve by name.

edited Nov 12, 2020 at 19:22

answered Nov 12, 2020 at 19:17

Tazz

1991 silver badge8 bronze badges

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

1 Comment

Serge Over a year ago

Only fix to this [HttpGet("id/{id}")] and [HttpGet("name/{name}")]

Rena · Accepted Answer · 2020-11-13 02:07:02Z

2

One way is like all of the other community members said,you could add additional part of the route to specify them.

Another way is that you could use Route constraint:

[HttpGet("{id:int}")]
public Student Get(int id)
{
}

[HttpGet("{name}")]
public Student Get(string name)
{
}

answered Nov 13, 2020 at 2:07

Rena

37.2k7 gold badges50 silver badges93 bronze badges

Comments

Farhad Zamani · Accepted Answer · 2020-11-12 19:46:50Z

0

You should change your route action to this

[HttpGet("id/{id}")]
public Student Get(int id)
{
    return GetStudents().FirstOrDefault(s=> s.id == id);
}

[HttpGet("name/{name}")]
public Student Get(string name)
{
    return GetStudents().FirstOrDefault(s=> s.name == name);
}

Then you can call your action like this

/Students/name/john

/Students/id/123

answered Nov 12, 2020 at 19:46

Farhad Zamani

5,9112 gold badges23 silver badges48 bronze badges

Comments

josvankamp · Accepted Answer · 2020-11-12 20:06:29Z

-2

This is impossible since you have created ambiguous routes.
Try it like this:

[HttpGet("id/{id}")]
public Student Get(int id)
{
    return GetStudents().FirstOrDefault(s=> s.id == id);
}

[HttpGet("name/{name}")]
public Student Get(string name)
{
    return GetStudents().FirstOrDefault(s=> s.name == name);
}

answered Nov 12, 2020 at 20:06

josvankamp

491 silver badge9 bronze badges

1 Comment

Serge Over a year ago

It s a copy of the previous answers

Collectives™ on Stack Overflow

Web-API controller multiple GET int and string parameters

4 Answers 4

1 Comment

Comments

Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

1 Comment

Comments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related