Model binding to Dictionary from URI in ASP.NET Web API

Question

Please refer to this link from MVC: http://aspnetwebstack.codeplex.com/discussions/351011

I am having trouble with model binding. From JavaScript I do an GET Ajax request to my API end point called "/api/products" passing in some parameters including paging and sorting as query parameters. Here is the complete URI:

http://localhost/api/products?page=1&count=10&filter[name]=Test1&filter[price]=10&sorting[name]=desc

On the server side, I have an Web API controller accepting these properties from the URI:

public async IHttpActionResult Get([FromUri]Dictionary<string,string> filter, [FromUri]Dictionary<string,string> sorting, int count, int page)
{
        //...
}

The "count" and "page" parameters bind perfectly fine, and the filter and sorting binds as an instance of a dictionary, but its count is 0.

I got this working in MVC but it doesn't seem to be doing the truck in Web API.

Check the solution proposed at http://stackoverflow.com/questions/11950351/method-with-dictionary-parameter-in-asp-net-web-api — Veverke, Apr 22 '15 at 12:09

score 4 · Answer 1 · edited Jul 14 '20 at 19:01

4

You can still leverage out of the box default model binder and your uri would look like

http://localhost/api/products?page=1&count=10&filter[0].key=name&filter[0].value=Test1&filter[1].key=price&filter[0].value=10&sorting[0].key=name&sorting[0].value=desc

edited Jul 14 '20 at 19:01

ataravati

8,891
9
57
89

answered Oct 09 '15 at 14:18

Lakshmana Prabhu Venkatesan

395
1
4
12

@LawrenceAiello, it's clearly apparent that the above link isn't a link to an off-site resource, but rather an example of a URL format. – Sam Hanley Oct 09 '15 at 19:46

score 0 · Answer 2 · edited Apr 22 '15 at 12:20

0

I think it is better to use a model as parameter, such as:

Public class model
{
Public Dictionary<string,string> filter{get;set;}
Public Dictionary<string,string> sorting{get;set;}
Public int sorting{get;set;}
}

public async IHttpActionResult Get(model yourModel)
{
        //...
}

edited Apr 22 '15 at 12:20

Veverke

9,208
4
51
95

answered Apr 08 '14 at 17:44

Hi Shahrooz, I've tried that but it's still not binding correctly on the dictionary properties – Fanie Reynders Apr 08 '14 at 17:45
@FanieReynders Please read:http://www.hanselman.com/blog/ASPNETWireFormatForModelBindingToArraysListsCollectionsDictionaries.aspx – Apr 08 '14 at 17:46
As I understand, modelbinding in web api works different from mvc – Fanie Reynders Apr 08 '14 at 17:53
@FanieReynders Yes very different – Apr 08 '14 at 17:54

score 0 · Answer 3 · answered Apr 26 '23 at 09:47

You could use a JSON string to keep the url short. The URI would be like

http://localhost/api/products?filter={"name":"Test","price":10}

Web API controller:

public void Get(string filter)
{
    var filterDictionary = JsonConvert.DeserializeObject<Dictionary<string, string>>(filter);
    //...
}

Model binding to Dictionary from URI in ASP.NET Web API

3 Answers3

Linked

Related