How to pass special character in query string in .Net core API?

Question

Net core application. I have one GET api as below:

        [HttpGet]
        [Route("configId={configId}&quoteId={quoteId}"), EnableQuery()]
        public async Task<IEnumerable<Scenario>> GetScenario(string configId, int quoteId)
        {
            var result = await configScenarioService.GetScenarioAsync(configId, quoteId);
            if (result.IsSuccess)
            {
                return result.scenarioResults;
            }
            return new List<Scenario>();
        }

I am trying to hit from Postman as below:

https://localhost:44362/api/v1/Scenario/configId=JBEL+ASS_60_SG_5.2-145_MY21_T102.5_25y&quoteId=236

Unfortunately, this is giving 404 error. Maybe the '+' sign is causing the issue. After looking into some documentation, I tried as below:

1. https://localhost:44362/api/v1/Scenario/configId="+ encodeURIComponent(BEL+ASS_60_SG_5.2-145_MY21_T102.5_25y) +"&quoteId=236

This didn't work for me and still gave a 404 error.

How can this be fixed?

Serge · Accepted Answer · 2022-04-08 06:18:08Z

2

since you have + sign you have to encode your url, for + url encoded is %2B https://www.w3schools.com/tags/ref_urlencode.asp

..../Scenario?configId=JBEL%2BASS_60_SG_5.2-145_MY21_T102.5_25y&quoteId=236

and since you have 404 you have to fix an action route too

[Route("~/api/v1/Scenario")]
 public async Task<IEnumerable<Scenario>> GetScenario([FromQuery] string configId, [FromQuery] int quoteId)

edited Apr 8, 2022 at 6:18

answered Apr 8, 2022 at 5:50

Serge

44.4k4 gold badges26 silver badges53 bronze badges

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

2 Comments

Mr Perfect Over a year ago

Yes this is working from swagger but my JS code files. I have below code const urlEncode = encodeURIComponent(configurationId) doGet(Scenario/GetScenario/configId=${urlEncode}&quoteId=${quote} when I see in network tab it is getting converted as configId=JBEL%2BASS_60_SG_5.2-145_MY21_T102.5_25y but when i try from swagger it is getting converted as configId=JBEL%252BASS_60_SG_5.2-145_MY21_T102.5_25y So difference in %2 and %252

Serge Over a year ago

@MrPerfect It should be %2B, see my updated answer. You can just try this string.replace("+", "%2B") if you have problems with encoding

RaZzLe · Accepted Answer · 2022-04-08 07:07:15Z

2

Then try this:

[ApiController]
[Route("api/v1/[controller]/[action]")]
public class YourController : ControllerBase
{
    //... ctor and your other stuff

    [HttpGet("{configId}/{quoteId}", Name = "Scenario")]
    [ProducesResponseType(typeof(IEnumerable<Scenario>)]
    public async Task<ActionResult<IEnumerable<Scenario>>> GetScenario(string configId, string quoteId)
    {
        
    }
}

edited Apr 8, 2022 at 7:07

answered Apr 8, 2022 at 6:00

RaZzLe

2,1503 gold badges19 silver badges28 bronze badges

Comments

kalit · Accepted Answer · 2022-04-08 05:30:54Z

1

Try this

[HttpGet]
        [Route, EnableQuery()]
        public async Task<IEnumerable<Scenario>> GetScenario([FromQuery(Name = "configId")]string configId, [FromQuery(Name = "quoteId")]int quoteId)
        {

answered Apr 8, 2022 at 5:30

kalit

2664 silver badges16 bronze badges

2 Comments

Mr Perfect Over a year ago

Thanks for your answer. I added above code [HttpGet] [Route("GetScenario"), EnableQuery()] public async Task<IEnumerable<Scenario>> GetScenario([FromQuery(Name = "configId")] string configId, [FromQuery(Name = "quoteId")] int quoteId) but dint work for me

Mr Perfect Over a year ago

from javascript also i tried but dint work out for me const urlEncode = encodeURIComponent(configurationId) doGet(Scenario/configId=${urlEncode}&quoteId=${quote}

Rahul Sharma · Accepted Answer · 2022-04-08 12:58:15Z

-1

what worked is const urlEncode = encodeURIComponent(encodeURIComponent(configId)) but still i am unable to figure it why i should use encodeURIComponent(encodeURIComponent) in my js

edited Apr 8, 2022 at 12:58

Rahul Sharma

8,3972 gold badges39 silver badges58 bronze badges

answered Apr 8, 2022 at 9:17

Mr Perfect

69519 silver badges36 bronze badges

Collectives™ on Stack Overflow

How to pass special character in query string in .Net core API?

4 Answers 4

2 Comments

Comments

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

2 Comments

Comments

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related