Web Api routing issue when using uri parameter and query string

Question

I'm struggling to get some Web Api 2.2 routing working correctly. I have a route:

config.Routes.MapHttpRoute(
            name: "OrgAdminGetOrgUsers",
            routeTemplate: "organisations/{id}/users",
            defaults: new { controller = "OrganisationDetails", action = "GetUsersInAnOrganisation" }                
        );

The problem I'm having is that when I add a query string for making the GET searchable, my routing stops working and I get 404's. I've looked everywhere for examples of using both Uri parameters and a query string, but I can't find anything. It seems like something people would do a lot though? When I remove the query string and the optional parameters from the controller the routing works fine.

Uri:

organisations/3/users?orderby=asc&orderByColumn=surname&start=1&end=15

Controller:

[HttpGet]
    public IEnumerable<User> GetUsersInAnOrganisation(int id, string email = "", string firstName = "", string surname = "", string orderByColumn = "", string orderBy = "asc", int start = -1, int end = -1)

Many thanks in advance for any help!

davoc bradley · Accepted Answer · 2015-11-23 14:03:33Z

1

So I've managed to get it working, the controller needed to be declared with [FromUri] for the id parameter:

[HttpGet]
public IEnumerable<User> GetUsersInAnOrganisation([FromUri] int id, string email = "", string firstName = "", string surname = "", string orderByColumn = "", string orderBy = "asc", int start = -1, int end = -1)

answered Nov 23, 2015 at 14:03

davoc bradley

2202 silver badges16 bronze badges

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

Comments

Amit Kumar Ghosh · Accepted Answer · 2015-11-23 12:54:26Z

0

This worked for me -

the config -

GlobalConfiguration.Configuration.Routes.MapHttpRoute(
            "Default", 
            "api/{controller}/{action}/{id}", 
            defaults: new { id = RouteParameter.Optional });

the url with query params -

http://localhost:57597/api/OrganisationDetails/GetUsersInAnOrganisation/3?
orderby=asc&orderByColumn=surname&start=1&end=15

Hope this is helpful.

answered Nov 23, 2015 at 12:54

Amit Kumar Ghosh

3,7761 gold badge22 silver badges24 bronze badges

1 Comment

davoc bradley Over a year ago

Hi, I don't really want to use that url template, I want to have organisations/{id}/users as this style of uri (having a parameter in the middle of it) will be used throughout the api.

Collectives™ on Stack Overflow

Web Api routing issue when using uri parameter and query string

2 Answers 2

Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related