Parameter Binding in ASP.NET Web API

Question

I have a DelegatingHandler in my web API for authentification (HMAC).

I would like to add a GET parameter to the request to return the user's id to my controller.

In my handler, I tried adding it like so:

public class SecurityHandler : DelegatingHandler
{
    protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
        string apikey = request.Headers.GetValues(AuthConfig.ApiKeyHeader).First();
        UserDTO user = UserRepo.GetUser(apikey);
        if (user == null)
        {
            return SendResponseText("Invalid API key");
        }

        // Validate signature ...

        // Add user Id to the URI
        request.RequestUri = new Uri(request.RequestUri.OriginalString + "&UserId=" + user.Id);
        return base.SendAsync(request, cancellationToken);
    }
}

In my controller, I'm able to get the newly added parameter from the request uri, however the parameter binding is not working

public class MyModel
{
    public int UserId { get; set; }
    ...
}

public string Get([FromUri] MyModel model)
{
    // model.UserId has not been set (= 0)
    // Request.RequestUri contains "&UserId=5"
}

Update

I'm guessing the binding is being done from the Params in the HttpContext. I tried something like this, but Params collection is readonly.

var newContext = request.Properties["MS_HttpContext"] as HttpContextWrapper;
newContext.Request.Params.Add("UserId", "8");
request.Properties.Remove("MS_HttpContext");
request.Properties.Add("MS_HttpContext", newContext);

If UserId is your first parameter, it should has ? instead of & request.RequestUri = new Uri(request.RequestUri.OriginalString + "?UserId=5"; — Shadi
– Shadi, Commented Dec 1, 2014 at 10:40
It seems that you did not check my last update that I made more than 8 hours ago — dotnetstep
– dotnetstep, Commented Dec 3, 2014 at 13:36

dotnetstep · Accepted Answer · 2014-12-03 01:34:40Z

5

+50

I have tried at my side and it working.

Here is my sample url.

http://localhost:50382/api/values?UserId=10

Here is controller action.

public class ValueController : ApiController
{
    public IEnumerable<string> Get([FromUri]Model my)
            {
                return new string[] { "value1", "value2" , my.UserId.ToString() };
            }
}

As per your comment here I created delegate handler.

  public class MyMessageHandler : DelegatingHandler
  {
    protected override Task<HttpResponseMessage> SendAsync(
            HttpRequestMessage request, CancellationToken cancellationToken)
    {
        var myTempObj = new { id = 20 };
      /* You have to check this and remove this key. If key present that FromUri use cached properties*/
        if (request.Properties.ContainsKey("MS_QueryNameValuePairs"))
        {
            request.Properties.Remove("MS_QueryNameValuePairs");                
        }

        // Now prepare or update uri over here. It will surely work now.
            if (!string.IsNullOrEmpty(request.RequestUri.Query) && request.RequestUri.Query.Contains('?'))
            {
                request.RequestUri = new Uri(request.RequestUri + "&UserID=" + myTempObj.id);
            }
            else
            {
                request.RequestUri = new Uri(request.RequestUri + "?UserID=" + myTempObj.id);
            }    

        return base.SendAsync(request, cancellationToken);
    }
}

It is work as expected.

If your original request contain userid then it get duplicated and it will not work. It return 0.

I also have doubt that you are using request.RequestUri.OriginalString. Just try to use request.RequestUri. It might possible that OriginalString has encoded value.

edited Dec 3, 2014 at 1:34

answered Dec 1, 2014 at 10:42

dotnetstep

17.5k6 gold badges61 silver badges80 bronze badges

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

7 Comments

ThunderDev Over a year ago

In my case I want to add a new parameter to the current request in my delegating handler.

dotnetstep Over a year ago

So once request comes you modify RequestUrl in your custom delegate handler. Is this you are doing ?

ThunderDev Over a year ago

Your example is similar to mine, tried it anyway but it doesn't not work. Did you actually get this to work ? I'm running on framework 4.0 by the way.

dotnetstep Over a year ago

Yes. It is working example. Did you try my handler ? I can only see problem with your URL.

ThunderDev Over a year ago

For some reason this only works if the original URI does not contain any parameters. If I add a parameter to the URI (eg. localhost:1234/api/forum?Product=10), then the binding of the UserId added in the handler does not work :(

|

ThunderDev · Accepted Answer · 2014-12-03 10:03:09Z

1

I found the following solution to my problem

request.RequestUri = new Uri(request.RequestUri + "&UserId=8");

var newFormDataCollection = new FormDataCollection(request.RequestUri);
request.Properties.Remove("MS_QueryNameValuePairs");
request.Properties.Add("MS_QueryNameValuePairs", newFormDataCollection);

return base.SendAsync(request, cancellationToken);

[FromURI] seems to use the values in the FormDataCollection, so you simply need to update the "MS_QueryNameValuePairs" property.

answered Dec 3, 2014 at 10:03

ThunderDev

1,1582 gold badges21 silver badges40 bronze badges

2 Comments

dotnetstep Over a year ago

My update somewhat similar and more than 8 hours ago

ThunderDev Over a year ago

Indeed, I did not get a notification of you edits. Thank you for your help ;)

Collectives™ on Stack Overflow

Parameter Binding in ASP.NET Web API

2 Answers 2

7 Comments

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

7 Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related