WebAPI routing to a function with multiple optional parameters

Question

I have the following function header in WebAPI controller declared as route:

[Route("page/{page}/{cityfilter?}/{statefilter?}/{organizationfilter?}")]
public IEnumerable<Contact> GetContact(int page, string cityfilter = null, string statefilter = null, string organizationfilter = null)
{
     ...
}

The issue here is that I'd wish that every parameter is optional, so I'd want to make a request that has either a cityfilter, a statefilter, an organization filter, two of them or three of them, and then be processed and router by this function, but I have no clue about how I can build the URI so that, for instance, this route works for just the statefilter.

How can I do that in WebAPI? How should I call the resource address from, for instance, a Jquery Ajax call?

Thank you.

Do you absolutely have to have the optional parameters in the url path? Is there a problem with having them as querystring parameters? — elolos
– elolos, Commented Oct 7, 2014 at 9:00
I could make the call as querystring no problem, but then how should I change the header of my WEBAPI function for that? Thanks — David Jiménez Martínez
– David Jiménez Martínez, Commented Oct 7, 2014 at 9:01

elolos · Accepted Answer · 2014-10-07 09:32:17Z

3

Since the parameters are simple types (strings), they can be bound either from the route data (URL path) or the query string. So you can move the optional parameters to the query string and have your route only match the page parameter.

[Route("page/{page}")]

Here's an example of a URL that you would use to call this action from the browser or from an AJAX call:

www.yourapidomain.com/page/1?cityfilter=aCityFilterString&statefilter=aStateFilterString&organizationfilter=anOrganizationFilter

You may of course omit any of the optional parameters or change their order.

The action method signature can remain as it is in your example.

For more information, you can have a look at parameter binding ASP.NET Web API.

edited Oct 7, 2014 at 9:32

answered Oct 7, 2014 at 9:11

elolos

4,4703 gold badges30 silver badges40 bronze badges

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

Collectives™ on Stack Overflow

WebAPI routing to a function with multiple optional parameters

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related