How to use Query String parameters in the ASP.NET MVC API

Question

[RoutePrefix("web/api")]
public class UsersController : BaseController
{
    [Route("users")]
    [HttpGet]
    public Response<List<UserDTO>> Get(string q, string ex)

I am trying to make the get function respond to : web/api/users?q=sd&ex=1

But it is not working?

score 1 · Answer 1 · answered Dec 11 '15 at 06:49

I gess your mistake is that you using RoutePrefix on controller class with Route on method.

If you want to call url like you show you should define your controller like this:

[RoutePrefix("web/api/users")]
public class UsersController : BaseController
{
    [HttpGet]
    public Response<List<UserDTO>> Get(string q, string ex)

Vaibhav Chaurasiya · Answer 2 · 2015-12-11T06:45:04.867

0

Try This :

`[RoutePrefix("web/api")]
public class UsersController : BaseController
{
    [Route("users/{q}/{ex}")]
    [HttpGet]
    public Response<List<UserDTO>> Get(string q, string ex)`

and just call api like : web/api/users/text1/text2

edited Dec 11 '15 at 06:45

answered Dec 11 '15 at 06:44

Vaibhav Chaurasiya

166
9

it won't work with url like `web/api/users?q=sd&ex=1` – teo van kot Dec 11 '15 at 06:44
call api like : web/api/users/text1/text2 – Vaibhav Chaurasiya Dec 11 '15 at 06:45

score 0 · Answer 3 · answered Dec 11 '15 at 06:46

0

You can add custom routes

config.Routes.MapHttpRoute(
    name: "NameOfRoute",
    routeTemplate: "web/{controller}/{action}?q={q}&ex={ex}",
    defaults: new { controller = "controller-name", action = "action-name", 
        q = RouteParameter.Optional, ex= RouteParameter.Optional }
    );

answered Dec 11 '15 at 06:46

Sandip Bantawa

2,822
4
31
47

I want to use Attribute Routing. – Rahul Kushwaha Dec 11 '15 at 06:52

score 0 · Answer 4 · answered Dec 11 '15 at 06:52

First of all, in order to be able to have multiple GET methods in the same controller, you must add your custom routes:

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

Then, in your controlller you need to mark the parameter as FromUri in order to tell the method to expect the parameter from the URI. This way, you will be able to call the method the following way:

/web/api/users/Get?q="your string1"&ex="ex"

public Response<List<UserDTO>> Get([FromUri]string q, [FromUri]string ex)

If this is the only GET method, you may skip the part with mapping custom routes.

Hope this helps.

Best of luck!

I want to use attribute routing/ – Rahul Kushwaha Dec 11 '15 at 07:13 — Rahul Kushwaha, Dec 11 '15 at 07:13

score 0 · Accepted Answer · answered Dec 12 '15 at 15:35

[RoutePrefix("web/api")]
public class UsersController : BaseController
{
    [Route("users")]
    [HttpGet]
    public Response<List<UserDTO>> Get(string q, string ex)

Sorry to bother you all, but this works perfectly fine. What I was doing wrong is that I had some controllers in the MVC project which pointed to the same url. As a result I was getting 404.

But thanks a lot all.

How to use Query String parameters in the ASP.NET MVC API

5 Answers5