CODEWITHSUNDEEP
c#asp.netasp.net-web-apiasp.net-web-api-routing
Martin
Martin

Reputation: 24308

asp.net webapi: how to pass optional parameters?

I am using the new asp.net web api and would like to pass optional parameters. Is it correct that one needs to populate an attribute so it allows one to pass params using the ? symbol?

Before this was done with with uri templates, I believe.

Does anyone have an example?

I am currently passing the id in the url which arrives in my controller as int. But I need to pass some dates.

Upvotes: 7

Views: 10562

Answers (2)

AlexGad
AlexGad

Reputation: 6692

In addition to the previous answer provided by Ian, which is correct, you can also provide default values which I feel is a cleaner option which avoids having to check whether something was passed or not. Just another option.

public class OptionalParamsController : ApiController
{
    // GET /api/optionalparams?id=5&optionalDateTime=2012-05-31
    public string Get(int id, DateTime optionalDateTime = DateTime.UtcNow.Date)
    {...}
}

Upvotes: 3

Ian Gilroy
Ian Gilroy

Reputation: 2041

You can make a parameter optional by using a nullable type:

public class OptionalParamsController : ApiController
{
    // GET /api/optionalparams?id=5&optionalDateTime=2012-05-31
    public string Get(int id, DateTime? optionalDateTime)
    {
        return optionalDateTime.HasValue ? optionalDateTime.Value.ToLongDateString() : "No dateTime provided";
    }
}

Upvotes: 6

Related Questions