How to pass multiple parameters via query string into a webapi controller

Question

I am working on a legacy system that has been using .Net remoting for its communication.Now I want to write new client and server side web-api code to do the same thing. Here's a sample code that I am dealing with :

public SearchResult Search(Condition condition,Sort sort,PageInfo pageInfo)
{
......
}

I would like to be able to have a web-api action with the same signature that gets its value form Uri , thus :

[HttpGet()]    
public SearchResult Search([FromUri]Condition condition,[FromUri]Sort sort,[FromUri]PageInfo pageInfo)
        {
        ......
        }

Here are my questions :

Is it possible to have such an action in a web-api ?
If yes, How can I pass these parameters using HttpClient ?

Community · Accepted Answer · 2017-05-23 12:21:53Z

3

You can setup your Route attribute to accept as many parameters as you like.

[Route("/api/search/{condition}/{sort}/{pageInfo}")]
[HttpGet]
public HttpResponseMessage Search( string condition, string sort, string pageInfo) {
    ...
}

This would mean that your url changes from
/Search?condition=test&sort=first&pageInfo=5
to
/Search/test/first/5

Alternatively, bundle the Condition, Sort and PageInfo objects into single Json class, and pass this object to your route:

[Route("/api/search/{SortParams}")]
[HttpGet]
public HttpResponseMessage Search( object sortParams) {
    // deserialize sortParams into C# object structure
}

Have a look at this question : C# .net how to deserialize complex object of JSON

edited May 23, 2017 at 12:21

CommunityBot

11 silver badge

answered May 15, 2014 at 7:51

blorkfish

23.1k4 gold badges35 silver badges24 bronze badges

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

3 Comments

Beatles1692 Over a year ago

I know but it means that I should write hundred of routes for hundred methods and there's a possibility that in future some parameters will be added to these methods thus we should change the route every time a new parameter is added.One other thing to note : Condition , Sort and PageInfo are objects not strings.

blorkfish Over a year ago

See the update on how to bundle Condition, Sort and PageInfo into a single Json object that can be passed into the function.

Beatles1692 Over a year ago

I had the same solution in mind but I was looking for an easier way (if possible). Thanks :)

Collectives™ on Stack Overflow

How to pass multiple parameters via query string into a webapi controller

1 Answer 1

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related