Web API 2 controller does not accept QueryString parameters

Question

I have a GET() controller to retrieve a list of entities. I want to pass a parameter to the action to filter the list of objects returned as follows:

Mysite.com/Users?nameContains=john

This is my action definition:

public IEnumerable<object> Get(string nameContains)
{
    // I want to use nameContains here
}

I get an error:

The requested resource does not support http method 'GET'.

If I revert the method to not get that parameter, it works.

@AmitAgrawal I'd rather not to because it wouldn't be compliant to the RESTful API best practices. @ssilas777 config.Routes.MapHttpRoute( name: "DefaultApi", routeTemplate: "api/{controller}/{id}", defaults: new { id = RouteParameter.Optional } ); — Nadav Miller
– Nadav Miller, Commented Feb 18, 2014 at 12:20
@NadavMiller Best practise in Web Api send parameter as body or define in URL and map that in registerRoute — Amit
– Amit, Commented Feb 18, 2014 at 12:21
@AmitAgrawal Where did you get that "best practice" advice because I've never heard of it before? — Darrel Miller
– Darrel Miller, Commented Feb 18, 2014 at 12:24

ssilas777 · Accepted Answer · 2014-02-18 12:25:08Z

1

Try this

public IEnumerable<object> Get([FromUri] string nameContains)
{
    // I want to use nameContains here
}

Also since you are working in Web Api 2, you can make use of attribute routing

[Route("users")]
public IEnumerable<object> Get([FromUri] string nameContains)
{

answered Feb 18, 2014 at 12:25

ssilas777

9,7704 gold badges48 silver badges70 bronze badges

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

Comments

Nadav Miller · Accepted Answer · 2014-02-18 12:41:17Z

1

Sorry, it was my mistake, I used 2 parameters and I didn't pass one of them (nor assigned it a default value) so it returned an error. Cheers.

answered Feb 18, 2014 at 12:41

Nadav Miller

4912 gold badges5 silver badges15 bronze badges

Comments

chridam · Accepted Answer · 2014-02-18 12:26:22Z

0

You can add a new route to the WebApiConfig entries.

For instance, your method definition:

public IEnumerable<object> Get(string nameContains)
{
    // I want to use nameContains here
}

add:

config.Routes.MapHttpRoute(
    name: "GetSampleObject",
    routeTemplate: "api/{controller}/{nameContains}"
);

Then add the parameters to the HTTP call:

GET //<service address>/Api/Data/test

or use HttpUtility.ParseQueryString in your method

// uri: /Api/Data/test 
public IEnumerable<object> Get()
{
    NameValueCollection nvc = HttpUtility.ParseQueryString(Request.RequestUri.Query);
    var contains = nvc["nameContains"];
    // BL with nameContains here
}

answered Feb 18, 2014 at 12:26

chridam

104k26 gold badges246 silver badges243 bronze badges

1 Comment

Darrel Miller Over a year ago

There should be no need to do this. Query parameter mapping does work.

Collectives™ on Stack Overflow

Web API 2 controller does not accept QueryString parameters

3 Answers 3

Comments

Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related