Android Retrofit api call with space in parameter

Question

I am trying to make an API call using Retrofit 1.x:

@POST("/test?api-version=1.0")
void createMyStuff(
        @Header("X-Signature") String authorization,
        @Query(value="nickname") String nickname,
        @Query("language") String language,
        Callback<MyAPIResponse> cb);

the issue is : nickname can have spaces in it. So, before make the call, if nickname is "John Doe" (two spaces), I replace space in it and send it like : "John%20%20Doe" in the API call.

It fails with 400, Bad request.

The URL reported in the errorResponse object is : https://.com/foo/test?nickname=john%2520%2520doe&language=en-US

Notice that the %20 is replaced by %2520

What I investigated : there isn't a definite answer. Someone on SO suggested in a thread to use FunName(value="apiname",encodeValue=true) But the encodeValue isn't resolving.

I also tried encoding with UTF-8 and it doesnt work. I am not sure about URL encoding since this is not really URL and will be only part of it.

Appreciate any help.

Answer 1

In Retrofit2 Parameter names and values are URL encoded by default. You need to add encoded = true to change this behaviour.

void createMyStuff(
    @Header("X-Signature") String authorization,
    @Query(value="nickname", encoded = true) String nickname,
    @Query("language") String language,
    Callback<MyAPIResponse> cb);

Answer 2

Actually %25 is encoding of % so when you put %20 it encodes % to %25 and 20 remains same. so you have to false its encoding in @Query parameter

@Query(value="nickname",encodeValue = false) String nickname

Now you can call it with %20 it will work fine

createMyStuff("Auth","John%20%20Doe","lang",new Callback<MyResponse>{....});