Binding querystring values to a dictionary

Question

I'm using Web API (part of ASP.NET MVC 5), and I'm trying to bind querystring values to a Dictionary<int, bool>.

My Web API method is simply:

[HttpGet]
[Route("api/items")]
public IQueryable<Item> GetItems(Dictionary<int, bool> cf)
{
    // ...
}

If I try to invoke this URL:

/api/items?cf[1009]=true&cf[1011]=true&cf[1012]=false&cf[1015]=true

The parameter cf is always null.

How can I pass in a dictionary of values via the QueryString to a Web API method?

score 8 · Accepted Answer · edited Apr 24 '17 at 18:51

8

When you want to pass a dictionary (basically key and value pair) using a query string parameter then you should use format like: &parameters[0].key=keyName&parameters[0].value=keyValue

In my Action method signature, parameters is defined as:

Dictionary<string,string> parameters

Hope this helps.

I was able to figure this our myself after reading this post from Scott Hanselman. So thanks to Scott!!

Thanks, Nirav

edited Apr 24 '17 at 18:51

Mikhail Antonov

1,297
3
21
29

answered Apr 24 '17 at 17:37

Nirav Darji

128
1
6

This is the correct answer, but I was not in control of the URL so this didn't work for me (I couldn't append `.key`/`.value`) - I ended up just manually iterating through `Request.Form` and parsing the results by hand. – qJake Jun 10 '20 at 14:24

score 0 · Answer 2 · answered Mar 28 '15 at 18:06

0

There is no built-in way of doing this. On this case, "cf[1009]" is the name of the parameter, not "cf". You can write you own query string parser to achieve what you need. A better signature would be:

/api/items?cf=1009&cf=1011&cf=1015

And you bind it by using:

public IQueryable<Item> GetItems(List<int> cf)
{
    // ...
}

answered Mar 28 '15 at 18:06

Marcelo Calbucci

5,845
3
18
22

1

This doesn't match the OP's requirements. There is more information needed about the `cf` entries: i.e. "true" or "false". – Steven Ryssaert Sep 11 '15 at 14:00

score 0 · Answer 3 · edited May 23 '17 at 12:02

0

You can create a ModelBinder for your dictionary, as described on this post:

https://stackoverflow.com/a/22708383

edited May 23 '17 at 12:02

Community

1
1

answered Jul 01 '16 at 01:54

Sérgio René

1

2

While this link may answer the question, [it is better](//meta.stackoverflow.com/q/8259) to include the essential parts of the answer here, and provide the link for reference. – Keale Jul 01 '16 at 02:00

Binding querystring values to a dictionary

3 Answers3

Linked