Handling illegal query string parameter names in ASP.NET Web API

Question

I have a client that is sending me a query string where several of the parameters begin with a dollar ($) sign. I can't start my parameters' names in C# with $, which means that the values are not mapping when my action is being called.

Before anyone asks, no I cannot have the client change the name of the query string.

I have a feeling I'm going to have to write some sort of custom action filter to find these parameters, rename them and then pass them on to the correct action. But, before I did all that, I wanted to post the question here to see if there's a solution I'm missing.

Thanks!

what version of web api?

Daniel Manta
– Daniel Manta

2016-08-12 23:03:03 +00:00
Commented Aug 12, 2016 at 23:03 — Daniel Manta
– Daniel Manta, Commented Aug 12, 2016 at 23:03

John · Accepted Answer · 2017-05-10 17:11:57Z

2

This is how I handled the issue:

    [HttpGet, Route("myResource")]
    public virtual IHttpActionResult GetThings()
    {
        var query = HttpUtility.ParseQueryString(Request.RequestUri.Query);
        var queryParam = query["$myParam"];

        return Ok();
    }

answered May 10, 2017 at 17:11

John

17.6k17 gold badges69 silver badges87 bronze badges

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

Comments

Community · Accepted Answer · 2017-05-23 11:47:07Z

1

Unfortunately, $ should not be used as part of the parameter names, as it is reserved in the URI definition

What does dollar sign $ do in url?

So the query string you are receiving is formally incorrect, and the best solution would be to change it, as future Http implementations or even some firewalls may break your solution.

A work around would be to override the query string parser, and access the URI directly, using HttpRequest properties Url (maybe the query method) or RawUrl:

https://msdn.microsoft.com/en-us/library/system.web.httprequest.url(v=vs.110).aspx

https://msdn.microsoft.com/en-us/library/system.web.httprequest.rawurl(v=vs.110).aspx

edited May 23, 2017 at 11:47

CommunityBot

11 silver badge

answered Aug 12, 2016 at 22:56

Bruno Guardia

4724 silver badges15 bronze badges

2 Comments

John Over a year ago

This news will come as a huge shock to the odata folks

Bruno Guardia Over a year ago

Agree... I was with a team that was part of defining OData some 10 years ago, and this was raised but didn't progress.

Collectives™ on Stack Overflow

Handling illegal query string parameter names in ASP.NET Web API

2 Answers 2

Comments

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related