How to post array in retrofit android

Question

How can I post following parameter in retrofit through post method ?

 "params":{"body": {
    "learning_objective_uuids": [
      "ED4FE2BB2008FDA9C8133FF462959C0968FAB98C4D1DB8F2"
    ],
    "note": "FasfAFSASFASDF",
    "user_uuids": [
      "EDF8B7EC20005ACC5C40FF7D6E988801F5BAD83CBBCDB97F",
      "EDF8F78F2000569C64101F244AA20C0070D2A7FCB1939E19"
    ]
  }
}
} }

These parameters :- "learning_objective_uuids": [ "ED4FE2BB2008FDA9C8133FF462959C0968FAB98C4D1DB8F2" ], "note": "FasfAFSASFASDF", "user_uuids": [ "EDF8B7EC20005ACC5C40FF7D6E988801F5BAD83CBBCDB97F", "EDF8F78F2000569C64101F244AA20C0070D2A7FCB1939E19" ] } } } — Deepak Sharma, May 16 '16 at 12:53
please type any reason in comments when you going downvote. This is constructive way i think — Yasin Kaçmaz, May 16 '16 at 13:06
@Revenge , I don't know why some stupid persons down vote the question. Its a genuine question . what do you think ? — Deepak Sharma, May 17 '16 at 07:23

hkaraoglu · Accepted Answer · 2018-06-08T07:26:17.407

62

@FormUrlEncoded
@POST("service_name") 
   void functionName(
        @FieldMap Map<String, String> learning_objective_uuids, @FieldMap Map<String, String> user_uuids, @Field("note") String note,
        Callback<CallBackClass> callback
    );

Better solution : Use arraylist.. Reference link : johnsonsu

@FormUrlEncoded
    @POST("service_name") 
       void functionName(
            @Field("learning_objective_uuids[]") ArrayList<String> learning_objective_uuids, @Field("user_uuids[]") ArrayList<String> user_uuids, @Field("note") String note,
            Callback<CallBackClass> callback
        );

edited Jun 08 '18 at 07:26

answered May 16 '16 at 12:56

hkaraoglu

1,345
1
15
34

Getting the following response :- retrofit.RetrofitError: 400 Bad Request – Deepak Sharma May 16 '16 at 13:21
Put your function that you wrote yourself. – hkaraoglu May 16 '16 at 13:30
Sure brother, Can you please tell me what is "lost_project_reasons[]" ? – Deepak Sharma May 17 '16 at 06:19
thanks for the answer, Second solution with arrayList worked! +1 – Deepak Sharma May 17 '16 at 06:43
you can also send array as int[] or long[] like this : @Field("lost_project_reasons[]") int[] learning_objective_uuids – Saba Sep 25 '17 at 16:40
is that Retrofit 1.x or 2.x? or both? – voghDev Oct 06 '17 at 05:35
@hkaraoglu your answer works well. but if i try same with hashMap> then response is something like ["[value-1,value-1]"]. can you help me out what i can do if i want to send parameter key name at runtime. also number of keys are not fixed. so i have to use HashMap only. please help. – Deepak Vajpayee Sep 17 '18 at 08:34
The best solution! Thanks! – V.March Mar 25 '19 at 16:40
A working solution for php servers which gets an array as a post param. In my case, the conjuction of @Field("fieldName[]") SomeObject[] param) worked. – March3April4 Jul 02 '19 at 04:26

score 8 · Answer 2 · answered May 16 '16 at 13:03

see this example where i need to pass registration fields data as json request

@POST("magento2apidemo/rest/V1/customers")
Call<RegisterEntity> customerRegistration(@Body JsonObject registrationData);

here i have created registrationData is

private static JsonObject generateRegistrationRequest() {
        JSONObject jsonObject = new JSONObject();
        try {
            JSONObject subJsonObject = new JSONObject();
            subJsonObject.put("email", "abc@xyz.com");
            subJsonObject.put("firstname", "abc");
            subJsonObject.put("lastname", "xyz");

            jsonObject.put("customer", subJsonObject);
            jsonObject.put("password", "password");

        } catch (JSONException e) {
            e.printStackTrace();
        }
        JsonParser jsonParser = new JsonParser();
        JsonObject gsonObject = (JsonObject) jsonParser.parse(jsonObject.toString());
        return gsonObject;
    }

Only point to be noted is "when you want to send array to server add that values to JsonArray and put it inside JsonObject." — MobileEvangelist, Sep 15 '19 at 09:46

score 7 · Answer 3 · answered Jul 03 '19 at 14:42

As of today, running the Retrofit implementation 'com.squareup.retrofit2:retrofit:2.1.0'

This works perfectly...

@FormUrlEncoded
@POST("index.php?action=item")
Call<Reply> updateManyItem(@Header("Authorization") String auth_token, @Field("items[]") List<Integer> items, @Field("method") String method);

You can disregard the @Header and @Field("method") .... the main piece is @Field("items[]") List<Integer> items

This is what allows you to send the items. On the API side I am simply looking for an array of integers and this works perfectly.

The only thing I forgot was the "[]" after the name of the field. Thank you very much ! — Quentin Doutriaux, Dec 11 '19 at 09:20

score 2 · Answer 4 · edited May 23 '17 at 12:26

2

Go to this site : JSON Schema 2 POJO

Paste your example Json format and then

Select source type : JSON , annotation style : None

Create a POJO class then , for example your class name : MyPOJOClass

Then in your Api :

@POST("endpoint")
public Call<Void> postArray(@Body MyPOJOClass mypojoclass);

If you have headers too you can add them in parameters like that :

@Header("Accept") String accept,@Header("Content-Type") String contentType

@Edit : for your comment checkout my answer : how-to-use-gson-2-0-on-onresponse-from-retrofit-2-0

edited May 23 '17 at 12:26

Community

1
1

answered May 16 '16 at 12:51

Yasin Kaçmaz

6,573
5
40
58

Currently I am using this method:- @POST(Constants.POST_UPLOAD_NOTES) public void postNotes(@Body JSONArray jsonArray ,@Query("note") String note, Callback callback); } – Deepak Sharma May 16 '16 at 12:55
checkout my @Edit section, you can find an example request and how to handle response .You can combine both answers – Yasin Kaçmaz May 16 '16 at 12:57

score 1 · Answer 5 · answered Sep 30 '19 at 17:44

I've found a new workaround:

you can send it as a String:

@POST("CollectionPoints")
@FormUrlEncoded
Call<SomeResponse> postSomething(@Field("ids")String ids);

and send pass it like this:

Call<SomeResponse> call = service.postSomething("0","0", Arrays.toString(new int[]{53551, 53554}));

Best Regards!

score 1 · Answer 6 · answered Oct 31 '20 at 12:19

Gson is the Best solution for JSON Object/Array related problems.

Here, I am sharing my easiest solution for passing array type value in retrofit API

id: ArrayList<String> //Already initilized 
status: String  //Already initilized 

val jsonObject = JsonObject()
val toJson = Gson().toJsonTree(id) //Only one line to covert array JsonElement

jsonObject.add("id", toJson) //Add Json Element in JsonObject

jsonObject.addProperty("status", status)

API Calling using jsonObject

@POST("API_END_POINT")
fun changeStatusOfList(@Body jsonObject: JsonObject): Observable<Response<RETURN_TYPE>>

Output in Log:

{"id":["426","427"],"status":"1"}

score -1 · Answer 7 · answered Feb 28 '19 at 22:41

if you want to send a list of the same name the only thing that worked for me in retrofit2 is to use @Query

@FormUrlEncoded
@POST("service_name") 
   void functionName(
        @Query("category") List<Int> categories
    );

this will send it like: https://example.com/things?category=100&category=101&category=105

the accepted answers seem not to work in Retrofit2

How to post array in retrofit android

7 Answers7

Linked

Related