How to pass multiple parameters to WebAPI Action using HttpClient.PostAsJsonAsync method?

Question

I have a Web API action as following:

[HttpPost]
public List<FavoriteDTO> GetFavoritesPaged(long userId, PagingInfo pagingInfo)
{
  var result = _userService.GetFavoritesPaged(fav => fav.UserId == userId, pagingInfo);
  var favDTOs = ConvertToDTOs(result.Source);
  return favDTOs;
}

I need to call it using HttpClient and I am trying it as following:

paging info needs to be passed to the get method.

var pagingInfo = new PagingInfo()
{
    PageIndex = 1,
    PageSize = 10,
    OrderBy = "URL",
    OrderDirection = OrderDirection.Desc
};

where OrderDirection is an enum:

public enum OrderDirection
  {
    Asc,
    Desc
  }

var detailURI = "Favorites/GetFavoritesPaged?userId="+34;

HttpClient client = new HttpClient()
client.BaseAddress="mywebApiAddress";
var response = client.PostAsJsonAsync(detailURI, pagingInfo).Result;
response.EnsureSuccessCode();
var result = JsonConvert.DeserializeObject(response.Content.ReadAsStringAsync().Result,
                                      tyepof(FavoritesDTO));

But, its not working. It says internal server error, what I am missing here; is the enum causing problem or something else? I have other WebAPIs working just fine; none of them has more than one parameter like this.

Here is my routConfig:

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

Is it the right way to call the WebAPI with multiple parameters or is there a better way, please suggest?

EDIT-1: changed this:

 var detailURI = "Favorites/GetFavoritesPaged?userId?"+34;

to:

var detailURI = "Favorites/GetFavoritesPaged?userId="+34;

All it was a typo :)

EDIT-2:

With EDIT-1 the request goes to follwing WebAPI method (which is wrong):

    [HttpPost]
    public FavoriteDTO AddToFavorites(FavoriteDTO favoriteDTO)
    {
      ------code to add to db------
    }

But, when I edited the routeConfig to the following:

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

Then I started getting the following exception:

ReasonPhrase: Not Found
Request: {Method: POST, RequestUri: 'http://localhost:60208/api/Favorite/GetPagedFavorites?user=1', Version: 1.1, Content: System.Net.Http.ObjectContent`1[[System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]], Headers:{  Content-Type: application/json; charset=utf-8  Content-Length: 44}}

JasonlPrice · Accepted Answer · 2013-10-07 16:27:55Z

3

You could try putting an ActionName attribute on the controller method. Then append the ActionName to your query string.

/ActionName?param=value

answered Oct 7, 2013 at 16:27

JasonlPrice

3073 silver badges14 bronze badges

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

Comments

Darin Dimitrov · Accepted Answer · 2013-03-11 11:39:10Z

1

Your url is wrong. Try like this:

var detailURI = "Favorites/GetFavoritesPaged?userId=34";

or use the {id} route:

var detailURI = "Favorites/GetFavoritesPaged/34";

But you're gonna have to modify your parameter name:

public List<FavoriteDTO> GetFavoritesPaged(long id, PagingInfo pagingInfo)

answered Mar 11, 2013 at 11:39

Darin Dimitrov

1.0m277 gold badges3.3k silver badges3k bronze badges

6 Comments

Baig Over a year ago

just updated my question as you pointed out. And its working. But, is there a better way that you can think of; instead of doing this (adding params in url).

Darin Dimitrov Over a year ago

There's nothing wrong in passing the Id parameter in the url. Another possibility is to use a view model and put everything in the POST body payload and then have your action take a single parameter which will represent your view model.

Baig Over a year ago

Actualy, it is still not working. It goes to another method which also has a POST verb attribute and a single parameter. [I was wrong initially when I said its working, since I didn't notice its going somewhere else]. When I change the route config (see the edit) it says "Not Found". Please see edit for more detail of exception.

Kiran Over a year ago

your Edit-2's uri seems to be having a typo "api/Favorite/"...should it be "api/Favorites" ?

Baig Over a year ago

@Kiran, Actually, I have renamed my controller from "FavoritesController" to "FavoriteController", thats why you see that. Any other clues?

|

SethMW · Accepted Answer · 2014-08-19 12:17:54Z

0

Another approach is to post an anonymous type, and have the Controller accept a dynamic.

var response = client.PostAsJsonAsync(new { detailURI, pagingInfo }).Result;

[HttpPost]
public List<FavoriteDTO> GetFavoritesPaged([FromBody]dynamic model)
{
    PagingInfo pagingInfo = (PagingInfo)model.pagingInfo;
    long userid = (long)model.userId;

    ...

}

answered Aug 19, 2014 at 12:17

SethMW

1,0821 gold badge9 silver badges10 bronze badges

Collectives™ on Stack Overflow

How to pass multiple parameters to WebAPI Action using HttpClient.PostAsJsonAsync method?

3 Answers 3

Comments

6 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

6 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related