Accessing the query string in ASP.Net Web Api?

Question

I'm using the default template generated by Asp.net Web Api. I'm working with the Get() part:

// GET api/values
public IEnumerable<string> Get()
{
    return new string[] { "value1", "value2" };
}

For some reason I thought the only thing you had to do to access to query string was just to create an input string variable. So I created one more function (the only change I made) to the default controller generated:

public IEnumerable<string> Get(string queryString)
{
    return new string[] { "value3", "value4" };
}

I put a breakpoint in both methods but even if I add a query string it always goes to the function with no parameters. So if I go to http://mybaseurl/api/values?foo=f it still is going to Get() instead of Get(string queryString). Does it not work the way I thought? I know I can access the query string in the Get() function using Request.RequestUri.ParseQueryString(); but I prefer to have it separated like this if possible.

score 68 · Answer 1 · edited May 23 '17 at 11:46

68

Even though @Kiran Challa's answer is correct, there are few situations that you might prefer to get URL parameters directly from the URL. in those scenarios, try this:

using System.Net.Http;

var allUrlKeyValues = ControllerContext.Request.GetQueryNameValuePairs();

string p1Val = allUrlKeyValues.LastOrDefault(x => x.Key == "p1").Value;
string p2Val = allUrlKeyValues.LastOrDefault(x => x.Key == "p2").Value;
string p3Val = allUrlKeyValues.LastOrDefault(x => x.Key == "p3").Value;

Now for the following URL, p1Val will be "Apple", p2Val will be "Banana", and p3Val will be null.

.../api/myController?p1=Apple&p2=Banana

Update:

Thanks for the suggestions, now, the source code for this test is in GitHub and it also runs and can be tested on Azure:

http://freewebapi.azurewebsites.net/api/values?p1=Apple&p2=Banana

edited May 23 '17 at 11:46

Community

1
1

answered Mar 16 '14 at 02:49

Tohid

6,175
7
51
80

2

I get an error 500 if I specify the same query name twice - this is permitted in HTTP (names can have multiple values) but it makes `freewebapi` crash: http://freewebapi.azurewebsites.net/api/values?p1=Apple&p2=Banana&p1=Foo – Dai Sep 06 '16 at 02:29
1

You are right @Dai Have to improve the code to avoid that exception. How about replacing .SingleOrDefault() with .FirstOrDefault() or .LastOrDefault() ? – Tohid Sep 07 '16 at 16:10

score 51 · Accepted Answer · edited May 15 '15 at 12:04

51

The query string key name should match the parameter name of the action:

/api/values?queryString=f

public IEnumerable<string> Get(string queryString)
    {
        return new string[] { "value3", "value4" };
    }

edited May 15 '15 at 12:04

Rafael Herscovici

16,558
19
65
93

answered Aug 24 '12 at 03:42

Kiran

56,921
15
176
161

if there in url we have ?$callback how can fetch that – saber tabatabaee yazdi Nov 26 '17 at 07:57

score 1 · Answer 3 · answered May 01 '20 at 11:48

There is one more way to get query string as shown below when you are using wildcard in route or for dynamic routes.

string query = ControllerContext.HttpContext.Request.QueryString.Value;

BONUS:)

string path = ControllerContext.HttpContext.Request.Path.ToUriComponent();

score 0 · Answer 4 · answered Jan 04 '23 at 20:58

0

This will also get you a specific query parmeter by name:

string testValue = request.GetQueryParameterDictionary().LastOrDefault(x =>
x.Key == "test").Value;

answered Jan 04 '23 at 20:58

K.J.M.O.

145
2
14

Accessing the query string in ASP.Net Web Api?

4 Answers4

Update:

Linked