Encoding parameters for a URL

Question

I have a Silverlight application that is building a URL. This URL is a call to a REST-based service. This service expects a single parameter that represents a location. The location is in the form of "city, state". To build this URL, I'm calling the following code:

string url = "http://www.example.com/myService.svc/";
url += HttpUtility.UrlEncode(locationTextBox.Text);

If a user enters "chicago, il" into locationTextBox, the result looks like this:

http://www.example.com/myService.svc/chicago%2c+il

In reality though, I was kind of expecting the URL to look like;

http://www.example.com/myService.svc/chicago,%20il

When testing my service via the browser URL, the one I am expecting works. However, the URL that is being generated is not working. What am I doing wrong?

Community · Accepted Answer · 2017-05-23 12:10:43Z

109

I would recommend Uri.EscapeDataString instead of using HttpUtility functions. See discussion in Server.UrlEncode vs. HttpUtility.UrlEncode.

edited May 23, 2017 at 12:10

CommunityBot

11 silver badge

answered Feb 23, 2011 at 19:19

Alexei Levenkov

101k15 gold badges138 silver badges189 bronze badges

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

1 Comment

Muhammedh Over a year ago

I tried this and still got the error for '#' character. Pls see my question here: stackoverflow.com/questions/31699335/…

JochemKempe · Accepted Answer · 2011-02-23 18:40:28Z

8

Try to use the UrlPathEncode() method. View the remarks at: http://msdn.microsoft.com/en-us/library/h10z5byc.aspx

Quote:

You can encode a URL using with the UrlEncode() method or the UrlPathEncode() method. However, the methods return different results. The UrlEncode() method converts each space character to a plus character (+). The UrlPathEncode() method converts each space character into the string "%20", which represents a space in hexadecimal notation. Use the UrlPathEncode() method when you encode the path portion of a URL in order to guarantee a consistent decoded URL, regardless of which platform or browser performs the decoding.

answered Feb 23, 2011 at 18:40

JochemKempe

2,8242 gold badges18 silver badges12 bronze badges

Comments

Elijah · Accepted Answer · 2025-03-11 15:32:46Z

7

Since there isn't an example that actually uses Uri.EscapeDataString, I'll add mine.

using System;

var email = "[email protected]";
var url = $"https://api.domain.com/send-email?email={Uri.EscapeDataString(email)}";

In ASP.NET Core 8+, you can also QueryHelpers.AddQueryString which uses UrlEncoder.Default.Encode under the hood.

using Microsoft.AspNetCore.WebUtilities;
KeyValuePair<string, string?>[] queryString = [new("email", "[email protected]")];
QueryHelpers.AddQueryString("https://api.domain.com/send-email", queryString)

edited Mar 11 at 15:32

answered Mar 29, 2024 at 19:24

Elijah

2,31825 silver badges35 bronze badges

Comments

Ken Egozi · Accepted Answer · 2011-02-23 19:21:17Z

0

The safest bet is to use the AntiXss library. It has more standard (and secure) versions for encoding contents to various purposes (like Url encodes, Html and HtmlAttribute encodes, and more). there's the old 3.1 version available for download from MS site (http://www.microsoft.com/downloads/details.aspx?FamilyId=051ee83c-5ccf-48ed-8463-02f56a6bfc09), which will work with older .NET versions, and the new one at http://wpl.codeplex.com/

answered Feb 23, 2011 at 19:21

Ken Egozi

1,84511 silver badges14 bronze badges

Collectives™ on Stack Overflow

Encoding parameters for a URL

4 Answers 4

1 Comment

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

1 Comment

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related