Optional parameter using Route attribute in web API?

Question

I want two patterns of API url point to the same API action method:

api/Cities/{countryCode}

and

api/Cities

Is this possible to configure using Route attribute?

I made this and didn't work:

   [HttpGet, Route("GetCities/{code?}")]
        public dynamic GetCities(string code)
        {
            return GENOrderRepository.SelectCities(Context, code);
        }

Possible duplicate of Attribute routing with optional parameters in ASP.NET Web API — The Bearded Llama
– The Bearded Llama, Commented Mar 20, 2017 at 17:13

Akos Nagy · Accepted Answer · 2017-03-20 17:09:07Z

15

Just create one action method, and use the route attribute like this:

Route[("api/Cities/{countryCode?}")]

(Note the question mark at the end, that makes a parameter optional). You also have to supply a default parameter to the parameter. See my working sample:

 [HttpGet, Route("GetCities/{code?}")]
 public IHttpActionResult GetCities(string code=null)
 {
     return Ok();
 }

edited Mar 20, 2017 at 17:09

answered Mar 20, 2017 at 15:00

Akos Nagy

4,3991 gold badge22 silver badges41 bronze badges

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

4 Comments

mshwf Over a year ago

Please see the amended question

Akos Nagy Over a year ago

Thanks for the sample. This shows that you have left out the default parameter from the action method. Please check my edit in the answer.

mshwf Over a year ago

I see it used like: num:int? what is this?

Akos Nagy Over a year ago

That specifies the url parameter num as an optional integer (:int for the integer and ? for the optional). By default url parameters are usually treated as strings.

Collectives™ on Stack Overflow

Optional parameter using Route attribute in web API?

1 Answer 1

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related