How to pass multiple parameters to a get method in ASP NET Core

Question

How can I pass in multiple parameters to Get methods in an MVC 6 controller  For example I want to be able to have something like the following    Route  api  controller     public class PersonController   Controller       public string Get int id                   public string Get string firstName  string lastName                    public string Get string firstName  string lastName  string address                   So I can query like   api person id 1 api person firstName john amp lastName doe api person firstName john amp lastName doe amp address streetA

User · Answer

NB-I removed FromURI  Still I can pass value from URL and get result If anyone knows benfifts using fromuri let me know

User · Answer

To call get with multiple parameter in web api core     ApiController       Route   controller         public class testController   Controller               HttpGet           Route  testaction  id int   startdate   enddate             public IEnumerable lt classname gt  test action int id  string startdate  string enddate                         return List classobject                    In web browser https   localhost 44338 test testaction 3 2010-09-30 2012-05-01

User · Answer

Simplest way   Controller    HttpGet  empId  empId  amp startDate  startDate  amp endDate  endDate      public IEnumerable lt Validate gt  Get int empId  string startDate  string endDate      Postman Request    router  empId 1 amp startDate 2020-20-20 amp endDate 2020-20-20   Learning point  Request exact pattern will be accepted by the Controller

User · Answer

To parse the search parameters from the URL  you need to annotate the controller method parameters with  FromQuery   for example    Route  api person    public class PersonController   Controller        HttpGet      public string GetById  FromQuery int id                     HttpGet      public string GetByName  FromQuery string firstName   FromQuery string lastName                     HttpGet      public string GetByNameAndAddress  FromQuery string firstName   FromQuery string lastName   FromQuery string address

User · Answer

I would suggest to use a separate dto object as an argument    Route  api  controller     public class PersonController   Controller       public string Get  FromQuery  GetPersonQueryObject request                   Your code goes here          public class GetPersonQueryObject        public int  Id   get  set        public string Firstname   get  set        public string Lastname   get  set        public string Address   get  set        Dotnet will map the fields to your object   This will make it a lot easier to pass through your parameters and will result in much clearer code

User · Answer

Why not using just one controller action   public string Get int  id  string firstName  string lastName  string address       if  id HasValue        GetById id      else if  string IsNullOrEmpty address         GetByName firstName  lastName      else       GetByNameAddress firstName  lastName  address       Another option is to use attribute routing  but then you d need to have a different URL format     api person byId id 1  HttpGet  byId     public string Get int id         api person byName firstName a amp lastName b  HttpGet  byName    public string Get string firstName  string lastName  string address

User · Answer

public HttpResponseMessage Get int id string numb                 using  MarketEntities entities   new MarketEntities                        var ent   entities Api For Test FirstOrDefault e   gt  e ID    id  amp  amp  e IDNO ToString     numb               if  ent    null                                return Request CreateResponse HttpStatusCode OK  ent                             else                               return Request CreateErrorResponse HttpStatusCode NotFound   Applicant with ID     id ToString       not found in the system

User · Answer

To add some more detail about the overloading that you asked about in your comment after another answer  here is a summary  The comments in the ApiController show which action will be called with each GET query   public class ValuesController   ApiController          EXPLANATION  See the view for the buttons which call these WebApi actions  For WebApi controllers                   there can only be one action for a given HTTP verb  GET  POST  etc  which has the same method signature   even if the param names differ  so                 you can t have Get string height  and Get string width   but you can have Get int height  and Get string width                   It isn t a particularly good idea to do that  but it is true  The key names in the query string must match the                 parameter names in the action  and the match is NOT case sensitive  This demo app allows you to test each of these                 rules  as follows                 When you send an HTTP GET request with no parameters   api values  then the Get   action will be called         When you send an HTTP GET request with a height parameter   api values height 5  then the Get int height  action will be called         When you send an HTTP GET request with a width parameter   api values width 8  then the Get string width  action will be called         When you send an HTTP GET request with height and width parameters   api values height 3 amp width 7  then the                  Get string height  string width  action will be called         When you send an HTTP GET request with a depth parameter   api values depth 2  then the Get   action will be called                 and the depth parameter will be obtained from Request GetQueryNameValuePairs           When you send an HTTP GET request with height and depth parameters   api values height 4 amp depth 5  then the Get int height                   action will be called  and the depth parameter would need to be obtained from Request GetQueryNameValuePairs           When you send an HTTP GET request with width and depth parameters   api values width 3 amp depth 5  then the Get string width                   action will be called  and the depth parameter would need to be obtained from Request GetQueryNameValuePairs           When you send an HTTP GET request with height  width and depth parameters   api values height 7 amp width 2 amp depth 9  then the                  Get string height  string width  action will be called  and the depth parameter would need to be obtained from                  Request GetQueryNameValuePairs           When you send an HTTP GET request with a width parameter  but with the first letter of the parameter capitalized   api values Width 8                   then the Get string width  action will be called because the case does NOT matter         NOTE  If you were to uncomment the Get string height  action below  then you would get an error about there already being                   a member named Get with the same parameter types  The same goes for Get int id                 ANOTHER NOTE  Using the nullable operator  e g  string  paramName  you can make optional parameters  It would work better to                 demonstrate this in another ApiController  since using nullable params and having a lot of signatures is a recipe                 for confusion          GET api values     public IEnumerable lt string gt  Get                 return Request GetQueryNameValuePairs   Select pair   gt   Get     gt      pair Key          pair Value             return new string      value1    value2                     GET api values 5       public IEnumerable lt string gt  Get int id                    return new string      Get height    gt  height      id                    GET api values height 5     public IEnumerable lt string gt  Get int height     int id                return new string      Get height    gt  height      height                  GET api values height 3     public IEnumerable lt string gt  Get string height                return new string      Get height    gt  height      height                    GET api values width 3       public IEnumerable lt string gt  Get string width                    return new string      Get width    gt  width      width                    GET api values height 4 amp width 3     public IEnumerable lt string gt  Get string height  string width                return new string      Get height  width    gt  height      height      width      width              You would only need a single route for this  in case you wondered       config Routes MapHttpRoute          name   DefaultApi           routeTemplate   api  controller   id            defaults  new   id   RouteParameter Optional            and you could test it all with this MVC view  or something simlar  Yes  I know you aren t supposed to mix JavaScript with markup and I m not using bootstrap like you would normally  but this is for demo purposes only    lt div class  jumbotron  gt       lt h1 gt Multiple parameters test lt  h1 gt       lt p class  lead  gt Click a link below  which will send an HTTP GET request with parameters to a WebAPI controller  lt  p gt   lt  div gt   lt script language  javascript  gt      function passNothing               get   api values   function  data    alert data                  function passHeight height              get   api values height     height  function  data    alert data                  function passWidth width              get   api values width     width  function  data    alert data                  function passHeightAndWidth height  width              get   api values height     height     amp width     width  function  data    alert data                  function passDepth depth              get   api values depth     depth  function  data    alert data                  function passHeightAndDepth height  depth              get   api values height     height     amp depth     depth  function  data    alert data                  function passWidthAndDepth width  depth              get   api values width     width     amp depth     depth  function  data    alert data                  function passHeightWidthAndDepth height  width  depth              get   api values height     height     amp width     width     amp depth     depth  function  data    alert data                  function passWidthWithPascalCase width              get   api values Width     width  function  data    alert data              lt  script gt   lt div class  row  gt       lt button class  btn  onclick  passNothing     gt Pass Nothing lt  button gt       lt button class  btn  onclick  passHeight 5    gt Pass Height of 5 lt  button gt       lt button class  btn  onclick  passWidth 8    gt Pass Width of 8 lt  button gt       lt button class  btn  onclick  passHeightAndWidth 3  7    gt Pass Height of 3 and Width of 7 lt  button gt       lt button class  btn  onclick  passDepth 2    gt Pass Depth of 2 lt  button gt       lt button class  btn  onclick  passHeightAndDepth 4  5    gt Pass Height of 4 and Depth of 5 lt  button gt       lt button class  btn  onclick  passWidthAndDepth 3  5    gt Pass Width of 3 and Depth of 5 lt  button gt       lt button class  btn  onclick  passHeightWidthAndDepth 7  2  9    gt Pass Height of 7  Width of 2 and Depth of 9 lt  button gt       lt button class  btn  onclick  passHeightWidthAndDepth 7  2  9    gt Pass Height of 7  Width of 2 and Depth of 9 lt  button gt       lt button class  btn  onclick  passWidthWithPascalCase 8    gt Pass Width of 8  but with Pascal case lt  button gt   lt  div gt

User · Answer

You also can use this      GET api user firstname lastname address  HttpGet   firstName   lastName   address     public string GetQuery string id  string firstName  string lastName  string address        return    firstName   lastName   address        Note  Please refer to metalheart s and metalheart and Mark Hughes for a possibly better approach

User · Answer

You can simply do the following        HttpGet      public async Task lt IActionResult gt  GetAsync                 string queryString   Request QueryString ToString   ToLower             return Ok await DoMagic GetAuthorizationTokenAsync new Uri   https   someurl com token-endpoint queryString               If you need to access each element separately  simply refer to Request Query

User · Answer

Methods should be like this    Route  api  controller     public class PersonsController   Controller        HttpGet   id         public Person Get int id        HttpGet      public Person   Get  FromQuery  string firstName   FromQuery  string lastName   FromQuery  string address       Take note that second method returns an array of objects and controller name is in plurar  Persons not Person    So if you want to get resource by id it will be   api persons 1   if you want to take objects by some search criteria like first name and etc  you can do search like this   api persons firstName Name amp       And moving forward if you want to take that person orders  for example   it should be like this   api persons 1 orders skip 0 amp take 20   And method in the same controller        HttpGet   personId  orders        public Orders   Get int personId  int skip  int take  etc

User · Answer

I think the easiest way is to simply use AttributeRouting    Route  api YOURCONTROLLER  paramOne   paramTwo         public string Get int paramOne  int paramTwo                return  The  Route  with multiple params worked

[c#] How to pass multiple parameters to a get method in ASP.NET Core

Examples related to c#

Examples related to asp.net-core

Examples related to asp.net-core-routing