Custom Parameter Names With Special Characters in ASP.NET Web API MVC 4

Question

I have a requirement to create a Get method which takes the following parameter names in the URL:

ms-scale ms-contrast ms-lang

As you can see, all the names have a dash in them which is not possible in C#. How can I map my method to these parameter names?

public HttpResponseMessage Get(int scale, string contrast string lang)

It can be done though custom model binder.

Kirill Bestemyanov
– Kirill Bestemyanov

2012-09-06 10:59:46 +00:00
Commented Sep 6, 2012 at 10:59 — Kirill Bestemyanov
– Kirill Bestemyanov, Commented Sep 6, 2012 at 10:59

phdesign · Accepted Answer · 2013-11-25 10:37:33Z

9

Use FromUriAttribute

public HttpResponseMessage Get([FromUri(Name = "ms-scale")]int scale, [FromUri(Name = "ms-contrast")]string contrast, [FromUri(Name = "ms-lang")]string lang)

answered Nov 25, 2013 at 10:37

phdesign

2,21223 silver badges18 bronze badges

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

1 Comment

Yura Over a year ago

This should be accepted answer. No need to write custom binders or whatever - just out-of-box solution.

Community · Accepted Answer · 2017-05-23 10:28:14Z

4

I was asked this before somewhere else and found this answer:

Using a dash (-) in ASP.MVC parameters

Updated

In order to get this working with Web API we need to modify it a bit.

[AttributeUsage(AttributeTargets.Method, AllowMultiple = true)]
public class BindParameterAttribute : ActionFilterAttribute
{
    public string ViewParameterName { get; set; }
    public string ActionParameterName { get; set; }

    public override void OnActionExecuting(HttpActionContext actionContext)
    {
        var viewParameter = actionContext.Request.RequestUri.ParseQueryString()[ViewParameterName];
        if (!string.IsNullOrWhiteSpace(viewParameter))
            actionContext.ActionArguments[ActionParameterName] = viewParameter;

        base.OnActionExecuting(actionContext);
    }
}

And how to use it:

[BindParameter(ActionParameterName = "customData", ViewParameterName = "custom-data")]
public string Get(string customData) {}

Please note, that this only works if your data comes from the uri, not body. How to make it work with POST data, I'm not really sure of at the moment.

edited May 23, 2017 at 10:28

CommunityBot

11 silver badge

answered Sep 6, 2012 at 11:00

Kordonme

2,2843 gold badges20 silver badges32 bronze badges

6 Comments

Muhammad Rehan Saeed Over a year ago

I set a breakpoint in the method and it does not seem to be breaking.

Muhammad Rehan Saeed Over a year ago

[ParameterName(ActionParameterName = "scale", ViewParameterName = "ms-scale")] [ParameterName(ActionParameterName = "contrast", ViewParameterName = "ms-contrast")] [ParameterName(ActionParameterName = "language", ViewParameterName = "ms-lang")] public HttpResponseMessage Get( int scale = 100, string contrast = "standard", string language = "en-us")

Kordonme Over a year ago

For Web API you should be using the System.Web.Http.Filters namespace. Are you using that namespace? I'll try and make an example.

Muhammad Rehan Saeed Over a year ago

If I use System.Web.Http.Filters.ActionFilterAttribute where does ActionExecutingContext come from? It keeps trying to reference System.Web.Mvc.ActionExecutingContext which is incorrect.

Muhammad Rehan Saeed Over a year ago

That does not seem to work if the parameter is an int. Works for String's though.

|

Collectives™ on Stack Overflow

Custom Parameter Names With Special Characters in ASP.NET Web API MVC 4

2 Answers 2

1 Comment

6 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

6 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related