Android Retrofit | Post custom object (send json to server)

Question

I was wondering how could I go about sending a custom object to my API using retrofit, something like this:

@POST(URL_ORDERS)
public void newOrder(Order order, Callback<Boolean> success);

Here's how I'd parse it on my server

public function store()
    {
    if(Auth::check()){
        $order = Input::get();
        $table = $order->table;
        $items = $order->items;

        if(!$table->taken){
            $table->taken = true;

            $order->push();
            $table->push();

            return true;
        }
    }

    return false;
}

For some reason I'm getting

06-04 20:45:59.275    6085-6306/com.tesis.restapp.restapp W/dalvikvm﹕ threadid=11: thread exiting with uncaught exception (group=0x40aae210)
06-04 20:45:59.285    6085-6306/com.tesis.restapp.restapp E/AndroidRuntime﹕ FATAL EXCEPTION: Retrofit-Idle
    java.lang.IllegalArgumentException: RestAppApiInterface.newOrder: No Retrofit annotation found. (parameter #1)
            at retrofit.RestMethodInfo.methodError(RestMethodInfo.java:120)
            at retrofit.RestMethodInfo.parameterError(RestMethodInfo.java:124)
            at retrofit.RestMethodInfo.parseParameters(RestMethodInfo.java:443)
            at retrofit.RestMethodInfo.init(RestMethodInfo.java:131)

I guess what I want it do to is to somehow transform my object into a json and send it to my server. Am I approaching this the right way?

James McCracken · Accepted Answer · 2014-06-05T00:03:32.220

29

The error is from not providing the @Body annotation on your Order parameter. Change it to:

@POST(URL_ORDERS)
public void newOrder(@Body Order order, Callback<Boolean> success);

Retrofit uses Gson to serialize and deserialize JSON by default. Gson uses variable names by default for serialization, but they can be changed using the annotation @SerializedName("replacement_name").

For Example, If your Order class looked like this:

public class Order {
    @SerializedName("custom_id")
    private int id;
    private String name;
    private List<Item> items;
}

public class Item {
    private int id;
    private String name;
}

Then Gson would automatically serialize that to

{
    "custom_id": 1,
    "name": "Hello Object",
    "items": [
        {
            "id": 1,
            "name": "Hello Item"
        }
    ]
}

edited Jun 05 '14 at 00:03

answered Jun 04 '14 at 23:55

James McCracken

15,488
5
54
62

right! :) that's what I figured. I don't know why the error though :/ (my Order class looks almost exactly as the one you wrote) – frankelot Jun 04 '14 at 23:59
What if a List were to be sent? – Nima Sep 29 '14 at 17:56
@JamesMcCracken You cannot provide /@Body if you are providing /@Query annotations. – IgorGanapolsky Apr 30 '15 at 16:07
1

@IgorGanapolsky what if we need to have both query and body annotations? – Alex Fragotsis May 11 '16 at 12:12
@JamesMcCracken can you please tell me how to get the value of order on server using getParameter() method in servlet? – Dhruvam Gupta Aug 13 '16 at 16:14
In my case it works after adding content-type to header of the post request: @Headers("Content-Type: application/json") – Misagh Dec 25 '18 at 14:31

Android Retrofit | Post custom object (send json to server)

1 Answers1

Linked