Asp.Net Core make Route parameter empty and send query parameters

Question

I have a controller with a GET method as follows:

 [HttpGet]
 [Route("customer/{custId}")]
 public ActionResult GetCustomers([FromRoute]string custId, string prodId= "", string tagNo = "")
 {
 }

I want this to work like:

 /api/customer/123  -- where it returns the data for customer id =123
 /api/customer      -- where it returns all customers
 /api/customer?prodId=xyz  --where it returns data for productId=xyz
 /api/customer?tagNo=xyz123

But currently, it only works in the following way:

 /api/customer/123?prodId=xyz

Is there a way I could do that in just one method

Nick Cromwell · Accepted Answer · 2019-12-03 21:50:30Z

4

I presume you're getting a 404 Not Found when trying to hit /api/customer. You can make the parameter optional by adding a ? at the end of the parameter name.

So the method signature would look like this:

[HttpGet]
[Route("customer/{custId?}")]
public ActionResult GetCustomers([FromRoute]string custId, [FromQuery]string prodId= "", [FromQuery]string tagNo = "")
{}

answered Dec 3, 2019 at 21:50

Nick Cromwell

2542 silver badges5 bronze badges

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

Comments

Piotr L · Accepted Answer · 2019-12-03 21:47:43Z

2

FromQuery attribbute may be helpful:

[HttpGet]
[Route("customer/{custId?}")]
public ActionResult GetCustomers(string custId, [FromQuery] string prodId = "", 
    [FromQuery] string tagNo = "")
{
}

This should work with every case.

answered Dec 3, 2019 at 21:47

Piotr L

9971 gold badge7 silver badges13 bronze badges

1 Comment

Piotr L Over a year ago

Also a hint: If you want to make your endpoinds more RESTful, you should use plural forms in route (customers)

Collectives™ on Stack Overflow

Asp.Net Core make Route parameter empty and send query parameters

2 Answers 2

Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related