Optional date parameter using Route attribute in web API

Question

I want to have two endpoints to my API method:

api/bids/

and

api/bids/{yyyy-MM-dd}

In first case i will map undefined date as today

I tried to make this way, but it did not work:

    [RoutePrefix("api/bids")]
    public class BidsController : ApiController
    {

        [HttpGet, Route("api/bids/{dateTime?}")]
        public async Task<IHttpActionResult> GetBids(DateTime? dateTime = null)
        {

            var correctDate = (dateTime != null) && (dateTime.Value >= DateTime.Now.Date);
            DateTime date = correctDate ? dateTime.Value : DateTime.Now.Date;

            try
            {
                return Ok(date);
            }
            catch (Exception ex)
            {
                string errorMessage = ex.Message;
                return BadRequest(errorMessage);
            }

        }
    }

How i can use optional date parameter with attribute routing in my case?

andyb952 · Accepted Answer · 2019-07-23 08:57:43Z

1

You need to make your parameter optional within the route as well as the default null assigning:

Also your Endpoint route needs to be changed to not include api/bids

[RoutePrefix("api/bids")]
public class BidsController : ApiController
{
    [HttpGet, Route("{dateTime:DateTime?}")]
    public async Task<IHttpActionResult> GetBids(DateTime? dateTime = null)
    {

        var correctDate = (dateTime != null) && (dateTime.Value >= DateTime.Now.Date);
        DateTime date = correctDate ? dateTime.Value : DateTime.Now.Date;

        try
        {
            return Ok(date);
        }
        catch (Exception ex)
        {
            string errorMessage = ex.Message;
            return BadRequest(errorMessage);
        }

    }
}

For ease of reading, I have changed this line

[HttpGet, Route("api/bids/{dateTime?}")]

to this

[HttpGet, Route("{dateTime:DateTime?}")]

edited Jul 23, 2019 at 8:57

answered Jul 23, 2019 at 8:22

andyb952

2,00913 silver badges29 bronze badges

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

5 Comments

Andrey Dengin Over a year ago

This approach returns a 404 error for both /api/bids/ and /api/bids/2019-01-01 requests.

andyb952 Over a year ago

This might be completely wrong, as haven't used Route prefix in a while. But doesn't your setup cause the route to be api/bids/api/bids/2019-01-01 - Let me know if that fixes the issue and I will change my answer to use correct routing also

andyb952 Over a year ago

Can you just try changing the Endpoint route to this: [HttpGet, Route("{dateTime:DateTime?}")] Let me know if that fixes your issue, if not then I am out of ideas...

Andrey Dengin Over a year ago

It works fine thanx! I understand that problem was related with duplicated RoutePrefix

andyb952 Over a year ago

No problem, just changed my original answer to reflect this

Collectives™ on Stack Overflow

Optional date parameter using Route attribute in web API

1 Answer 1

5 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

5 Comments

Your Answer

Sign up or log in

Post as a guest

Related