ASP.NET Webapi with parameter

Question

I am building a webapi to getBalance of a customer from Db.It works well and i can retrieve the data.But the problem is in the parameter part.

For eg. In ASP.NET webservice when we request the service it gives us a page where according to the the service we get to enter the parameters in the textbox and upon

firing up the service we get the data.

I have my webapi up and running and the uri looks like this --- http://localhost/api/accounts/balance/cs-001

AccountsController

public class AccountsController : ApiController
{

    [HttpGet]
    [ActionName("balance")]
    public string Getbalance(string accountNumber)
    {
        var data = BusinessLayer.Api.AccountHolderApi.GetBalance(accountNumber);

        return data;
    }

}

And my route

RouteTable.Routes.MapHttpRoute("OfficeApi", "api/{controller}/{action}/{accountNumber}");

So the accountNumber is the paramater here.Now one of my mobile app dev friend to is going to use this api suggests me to move account number in parameter rather than url.Like in my case we append the parameter in the url to retrieve the balance from the db.I want to know how to move the account number (the param) from the url to parameter in asp.net webapi.

I am new to webapi.Help needed.Thank You.

Avitus · Accepted Answer · 2017-05-27 17:15:09Z

2

All you have to do is change the route since account number is already a parameter on the function:

RouteTable.Routes.MapHttpRoute("OfficeApi", "api/{controller}/{action}");

Then you'll be able to do:

http://localhost/api/accounts/balance?accountNumber=cs-001

answered May 27, 2017 at 17:15

Avitus

16k6 gold badges47 silver badges54 bronze badges

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

1 Comment

OLDMONK Over a year ago

Wow.thank you sir.I have a small question.Now, to say give my api to the one who wants to use it..should the format be in this order--domain/api/accounts/balance{param}.

CodingYoshi · Accepted Answer · 2017-05-27 17:27:15Z

1

@Avitus's answer is correct. Here is some belabor in case you are interested.

If someone requests this URL: http://localhost/api/accounts/balance?accountNumber=cs-001

ASP.NET routing will figure out the controller and action based on your routing configuration. Once the controller and action have been discovered, then it will try to bind the parameters in the action like this:

By default, Web API uses the following rules to bind parameters:

If the parameter is a "simple" type, Web API tries to get the value from the URI. Simple types include the .NET primitive types (int, bool, double, and so forth), plus TimeSpan, DateTime, Guid, decimal, and string, plus any type with a type converter that can convert from a string. (More about type converters later.)

For complex types, Web API tries to read the value from the message body, using a media-type formatter.

Here is the full article.

answered May 27, 2017 at 17:27

CodingYoshi

27.3k7 gold badges68 silver badges75 bronze badges

1 Comment

OLDMONK Over a year ago

Thank you for the belabor part sir.:)

Collectives™ on Stack Overflow

ASP.NET Webapi with parameter

2 Answers 2

1 Comment

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related