How to pass single object instead of multiple parameters in Web API C#

Question

In my Web API application, I want to pass multiple condition to filter out data in database. Those condition will be pass from UI.

string dateRangeType = "XYZ", string startDate = "", string endDate = ""

So how can I combine those 3 parameters into single object and used in Web API GET method in C#

How?? It all depends on how the web API is accepting the parameters. You need to show us code of the web API and also the code of how you are calling the web API. — Chetan Ranpariya, Oct 09 '17 at 04:56

score 2 · Accepted Answer · answered Oct 09 '17 at 07:10

You can create a model class and use it as the parameter of the web api controller. For example:

public class MyDateDTO
{
    public String dateRangeType { get; set; }
    public String startDate { get; set; }
    public String endDate { get; set; }
}

Next in your web api controller

    [HttpGet]
    public String MyDateAction([FromUri]MyDateDTO dto)//must put FromUri or else 
        //the web api action will try to read the reference type parameter from
        //body
    {
        //your code
    }

Also note that you have to put FromUri in order to be able to read the reference type object from the query parameter as by default the action will try to read it from the body. More details here.

Ipsit Gaur · Answer 2 · 2017-10-09T05:06:48.543

0

You can add all these 3 properties in a class and then pass that object as parameter and then post data using body will do the job

public class MyContract {
    public string dateRangeType;
    public string startDate;
    public string  endDate;
}

Change the signature of your action to pass MyContract object as a parameter with [FromBody] attribute, and then pass data as JSON in your request body like this -

{
   dateRangeType: "abc",
   startDate: "2017-09-10",
   endDate: "2017-09-11"
}

edited Oct 09 '17 at 05:06

answered Oct 09 '17 at 04:56

Ipsit Gaur

2,614
1
19
34

Can we do this for GET ? – DevPerson Oct 09 '17 at 05:01
Yes, you can pass body paramters using GET as well, ideally you should use POST but using GET will also work – Ipsit Gaur Oct 09 '17 at 05:03
See https://stackoverflow.com/questions/978061/http-get-with-request-body for why you shouldn't do it though you can. – Alexander Schmidt Oct 09 '17 at 06:08
@sprinter252 Yes, exactly. – Ipsit Gaur Oct 09 '17 at 06:16

Vijay Raheja · Answer 3 · 2017-10-09T05:05:30.427

-2

In Get you can not pass single object, for this you need to convert method into POST method. WebApi Accepts data via FormFactory and via JSON Factory. These two convert request data into object for post only not for GET. For GET we need only parameters as single as method input parameters. You can check also Model Binder which follows the same approach.

edited Oct 09 '17 at 05:05

answered Oct 09 '17 at 04:55

Vijay Raheja

262
2
10

1

This does not answer the question completely. You can share this information via comments. – Chetan Ranpariya Oct 09 '17 at 04:57
@VijayRaheja I want to do this in GET only, is there any alternative? – DevPerson Oct 09 '17 at 05:00
@Vijay There is no need to make it POST, Kcs see my answer – Ipsit Gaur Oct 09 '17 at 05:00

How to pass single object instead of multiple parameters in Web API C#

3 Answers3