Multiple NULL values in Web API Get Method Parameter

Question

I have this kind of sample code below that calls an API using get method:

CrudService.getAll("sampleurl/param1/param2/param3");

From that sample, param1 and param2 can be null/blank value. What happens is that the value of param3 goes to param1 when it comes to the API Controller.

How can I maintain the right values for the parameter even if there can be several null/blank values?

Are you using C# and ASP.NET Web API? If so, then please consider to add c# and asp.net-web-api tags to your question. There's a bigger chance to get answers if you use the correct / relevant tags. — ekad
– ekad, Commented Sep 11, 2018 at 11:24
If the input is a string wouldn't you just have to call "sampleurl///param3" this seems like bad design though, or i might be misunderstanding your question. — Jim Wolff
– Jim Wolff, Commented Sep 12, 2018 at 7:05
If you are in control of the web api, why not switch to adding parameters as query string and then you can extract via FromUri attrubute. See this: forums.asp.net/t/… — user869375
– user869375, Commented Sep 12, 2018 at 7:07
If you are in control of the service being called then you need to show the API controller action along with the routes in a minimal reproducible example. What you have shown so far is an XY problem and not enough for us to help you. — Nkosi
– Nkosi, Commented Sep 12, 2018 at 12:16

Paul Karam · Accepted Answer · 2018-09-13 20:34:08Z

7

+25

CrudService.getAll("sampleurl/param1/param2/param3");

You have to pass a dummy value for param1 so if param1 is empty keep it "param1". various possible call based on empty params :

("sampleurl/param1/param2/2");
("sampleurl/param1/3/2");
("sampleurl/param1/param2/param3");

So when the call goes to API, check there is param1=param1 ignore the value you have to keep 3 values in order to match the signature of API in any case.

edited Sep 13, 2018 at 20:34

Paul Karam

4,2908 gold badges36 silver badges59 bronze badges

answered Sep 12, 2018 at 14:45

Jin Thakur

2,81322 silver badges16 bronze badges

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

Comments

Mohd Shakhtour · Accepted Answer · 2018-09-12 07:42:16Z

5

if your using asp API the parameters should send like this.

  string url = $"https://example.com/api/controllerName/Action?parms1={value}&parms2={value}";
                                    response = client.GetAsync(url).Result;

And if you are using asmx you should edit the web service to handle the parameters like this:

CrudService.getAll("sampleurl",parm1,parm2,etc..);

I hope this will help you.

answered Sep 12, 2018 at 7:42

Mohd Shakhtour

17513 bronze badges

Comments

Hossein · Accepted Answer · 2018-09-18 05:28:33Z

3

If you choose such a url structure, it means you have some sort of hierarchy structure. For example mysite.com/vehicle/car/mercedes/classc/details/engine could show or return details of the engine of a class C mercedes. It goes without saying that not transmitting the brand or the car model doesn't make sense.

If you want to keep this hierarchical structure, you must expose an url that permits you to mention the category "undefined" in the structure like: mysite.com/vehicle/car/brandlesscars/mybrandlessmodel/details/engine

If the segments of your url represent a parameter of a query but not a path sequence to access to a more detailed section, it is way better to have a url with parameters like this: mysite.com/vehicle/details/engine?type=car&brand=mercedes&model=classc.

edited Sep 18, 2018 at 5:28

Hossein

3,1233 gold badges18 silver badges35 bronze badges

answered Sep 16, 2018 at 19:12

Stephane

1,5011 gold badge16 silver badges30 bronze badges

Comments

Alta · Accepted Answer · 2018-09-15 09:57:16Z

1

you could explicitly send the request with parameters names and values just like the answer from Paul and applying this to your example: CrudService.getAll("http://sampleurl/controller/action?param1="value"&param2="value&param3=value");

i hope this will help you

answered Sep 15, 2018 at 9:57

Alta

112 bronze badges

Comments

Stuart · Accepted Answer · 2018-09-18 03:50:09Z

0

The answer of @Jin Thakur is one way to do it but I did this instead. Similar to the answer of @Sinan. Thanks all.

From JS:

CrudService.getAll("/api/home/monitor/param?param1=&param2=&param3=val1");

From C# API:

[Route("api/home/monitor/param")]
[HttpGet]
public IHttpActionResult GetSomeValue(string param1, string param2, string param3)
{

//Some Codes

}

answered Sep 18, 2018 at 3:50

Stuart

6891 gold badge12 silver badges35 bronze badges

Collectives™ on Stack Overflow

Multiple NULL values in Web API Get Method Parameter

5 Answers 5

Comments

Comments

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

Comments

Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related