call to web api with string parameter

Question

I have a web api where I have 2 methods, one without parameter and two with different types of parameter (string and int). When calling the string method it doesnt work...what am I missing here?

public class MyControllerController : ApiController
{
    public IHttpActionResult GetInt(int id)
    {
        return Ok(1);
    }

    public IHttpActionResult GetString(string test)
    {
        return Ok("it worked");
    }
}

WebApiConfig.cs:

public static void Register(HttpConfiguration config)
{
    // Web API configuration and services

    // Web API routes
    config.MapHttpAttributeRoutes();

    config.Routes.MapHttpRoute(
        name: "DefaultApi",
        routeTemplate: "api/{controller}/{id}",
        defaults: new { id = RouteParameter.Optional }
    );
}

My Call:

/api/MyController/MyString //Doesnt work

/api/MyController/1 //work

I get following error:

The parameters dictionary contains a null entry for parameter 'id' of non-nullable type 'System.Int32' for method 'System.Web.Http.IHttpActionResult GetInt(Int32)' in 'TestAngular.Controllers.MyControllerController'. An optional parameter must be a reference type, a nullable type, or be declared as an optional parameter.

What am I missing in my request?

You cannot use the same route for two different endpoint. The methode GetInt wins and will use for both requests. — PinBack
– PinBack, Commented Nov 19, 2015 at 10:07
Set routeTemplate: "api/{controller}/{action}/{id}" and see my answer — PinBack
– PinBack, Commented Nov 19, 2015 at 10:25

sa_ · Accepted Answer · 2017-07-16 19:43:14Z

9

Here is my solution: without changing default route in webapiconfig.cs file

add just a route to your string function:

[Route("Api/MyController/GetString/{test}")]
public IHttpActionResult GetString(string test)

http://localhost:49609/api/MyController/GetString/stringtest

edited Jul 16, 2017 at 19:43

answered Jul 10, 2017 at 12:28

sa_

3,0343 gold badges25 silver badges30 bronze badges

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

Comments

PinBack · Accepted Answer · 2015-11-19 09:53:24Z

8

Also this uri's should work:

api/MyController/GetAll
api/MyController/GetString?param=string
api/MyController/GetInt?param=1

I think this is much clearer and should always work. You use the routing behavior.

See here: http://www.asp.net/web-api/overview/web-api-routing-and-actions/routing-and-action-selection

edited Nov 19, 2015 at 9:53

answered Nov 19, 2015 at 9:03

PinBack

2,58415 silver badges18 bronze badges

Comments

Christos · Accepted Answer · 2015-11-19 08:42:54Z

7

You have to change your uri's

/api/MyController

/api/MyController/string 

/api/MyController/1

You don't have to specify the methods.

You could take look at this tutorial on asp.net for further clarification.

answered Nov 19, 2015 at 8:42

Christos

54.1k9 gold badges82 silver badges114 bronze badges

5 Comments

MrProgram Over a year ago

I tried to follow that tutorial and apply on my project but I didn't get to work..So thats why I'm asking here, I must have missed something

Christos Over a year ago

@emptyman so did you try to call these uri's and you didn't get any response?

MrProgram Over a year ago

I got the int to work, but how do I send a string parameter? It cant find the method (it looks for the int)

Christos Over a year ago

I don't think that you need any extra work. You simply have to make a get request to this /api/MyController/yourstringvalue

MrProgram Over a year ago

I've updated my question..Now the int method works fine (after tuning from your tutorial). But I can't get my string to work

Phil3992 · Accepted Answer · 2017-09-06 09:53:42Z

4

It's been a while since you posted this, but I think I have the answer. First off, there are two issues. First, as Pinback noted, you can't use the same route for two different endpoints.

However if you just eliminate the int method, you'll still run into the problem. Remember: the default route looks like this: api/{controller}/{id} In order to bind the parameter, it has to be called "id", and not "test".

Change the signature to this:

public IHttpActionResult GetString(string id)

and it will work. (you can also change {id} to {test} in the webapiconfig.cs file).

edited Sep 6, 2017 at 9:53

Phil3992

1,0557 gold badges21 silver badges46 bronze badges

answered Jul 9, 2017 at 20:41

kensuprime

411 bronze badge

Comments

francescalus · Accepted Answer · 2018-11-27 13:46:21Z

0

You can also take string parameter in body

string body;
using (var sr = new StreamReader(Request.Body))
body = sr.ReadToEnd();

edited Nov 27, 2018 at 13:46

francescalus

32.9k28 gold badges86 silver badges128 bronze badges

answered Nov 27, 2018 at 13:38

codeInDream

11 bronze badge

Collectives™ on Stack Overflow

call to web api with string parameter

5 Answers 5

Comments

Comments

5 Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

Comments

Comments

5 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related