Retrofit and GET using parameters

Question

I am trying to send a request to the Google GeoCode API using Retrofit   The service interface looks like this   public interface FooService            GET   maps api geocode json address  zipcode  amp sensor false       void getPositionByZip  Path  zipcode   int zipcode  Callback lt String gt  cb       When I call the service   OkHttpClient okHttpClient   new OkHttpClient     RestAdapter restAdapter   new RestAdapter Builder   setEndpoint Constants GOOGLE GEOCODE URL  setClient new OkClient okHttpClient   build     FooService service   restAdapter create FooService class    service getPositionByZip zipCode  new Callback lt String gt           Override public void success String jsonResponse  Response response                      Override public void failure RetrofitError retrofitError                I receive the following stacktrace   06-07 13 18 55 337  E AndroidRuntime 3756   FATAL EXCEPTION  Retrofit-Idle 06-07 13 18 55 337  E AndroidRuntime 3756   Process  com marketplacehomes  PID  3756 06-07 13 18 55 337  E AndroidRuntime 3756   java lang IllegalArgumentException  FooService getPositionByZip  URL query string  address  zipcode  amp sensor false  must not have replace block  06-07 13 18 55 337  E AndroidRuntime 3756       at retrofit RestMethodInfo methodError RestMethodInfo java 120  06-07 13 18 55 337  E AndroidRuntime 3756       at retrofit RestMethodInfo parsePath RestMethodInfo java 216  06-07 13 18 55 337  E AndroidRuntime 3756       at retrofit RestMethodInfo parseMethodAnnotations RestMethodInfo java 162  06-07 13 18 55 337  E AndroidRuntime 3756       at    I took a look at the StackOverflow question  Retrofit  multiple query parameters in  GET command  but it did not seem applicable   I took the code pretty much verbatim from here  http   square github io retrofit  so I am a bit of a loss to understand the issue   Thoughts

User · Accepted Answer

AFAIK        can only be used as a path  not inside a query-param  Try this instead   public interface FooService             GET   maps api geocode json sensor false       void getPositionByZip  Query  address   String address  Callback lt String gt  cb       If you have an unknown amount of parameters to pass  you can use do something like this   public interface FooService             GET   maps api geocode json        FormUrlEncoded     void getPositionByZip  FieldMap Map lt String  String gt  params  Callback lt String gt  cb

User · Answer

QueryMap worked for me instead of FieldMap  If you have a bunch of GET params  another way to pass them into your url is a HashMap   class YourActivity extends Activity    private static final String BASEPATH    http   www example com    private interface API        GET   thing       void getMyThing  QueryMap Map lt String  String gt  params  new Callback lt String gt  callback      public void onCreate Bundle savedInstanceState       super onCreate savedInstanceState      setContentView R layout your layout       RestAdapter rest   new RestAdapter Builder   setEndpoint BASEPATH  build       API service   rest create API class       Map lt String  String gt  params   new HashMap lt String  String gt        params put  key1    val1       params put  key2    val2              as much as you need      service getMyThing params  new Callback lt String gt                    do some stuff here               The URL called will be http   www example com thing  key1 val1 amp key2 val2

User · Answer

Complete working example in Kotlin  I  have replaced my API keys with 1111             val apiService   API getInstance   retrofit create MyApiEndpointInterface  class java          val params   HashMap lt String  String gt            params  q       munich de          params  APPID      11111111111111111           val call   apiService getWeather params           call enqueue object   Callback lt WeatherResponse gt                override fun onFailure call  Call lt WeatherResponse gt    t  Throwable                     Log e  Error      Error   t   message                             override fun onResponse call  Call lt WeatherResponse gt    response  Response lt WeatherResponse gt                      if  response    null  amp  amp  response isSuccessful  amp  amp  response body      null                        Log e  SUCCESS      Response    response body     main temp                       temperature setText     response body     main temp

User · Answer

I also wanted to clarify that if you have complex url parameters to build  you will need to build them manually  ie if your query is example com  latlng -37 147  instead of providing the lat and lng values individually  you will need to build the latlng string externally  then provide it as a parameter  ie   public interface LocationService            GET   example        void getLocation  Query value  latlng   encoded true  String latlng       Note the encoded true is necessary  otherwise retrofit will encode the comma in the string parameter  Usage   String latlng   location getLatitude           location getLongitude    service getLocation latlng

[android] Retrofit and GET using parameters

Examples related to android

Examples related to get

Examples related to retrofit