REST - Define name for JSON array from Restful Java Service

Question

I got the following function in my REST Java service running in a Glassfish Server:

serviceTest.java

@Path("/servicetest")
public class serviceTest{
    @GET
    @Path("/findall")
    @Produces(MediaType.APPLICATION_JSON)
    public List<Person> findAll(){
        List <Person> result = new ArrayList<>();
        result.add(new Person("1", "Charlie");
        result.add(new Person("2", "Mary");
        return result;
        }
    }

Also I have defined a class:

person.java

public class person {

    private String id;
    private String name;

    public person(String id, String name) {
        this.id = id;
        this.name = name;
    }

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

When I called the findAll() function from the client side or a web browser, I'm getting the following JSON object in this format:

[
    {
        "id": "1",
        "name": "Charlie"    
    },

    {
        "id": "2",
        "name": "Mary"  
    }
]

But I need to identify the JSON array by a name, something like this:

{"person":
    [
        {
            "id": "1",
            "name": "Charlie"    
        },

        {
            "id": "2",
            "name": "Mary"  
        }
    ]
}

How can I do this...? Thanks in advance...

wero · Accepted Answer · 2016-02-11 21:24:49Z

2

You can wrap the person list in a map:

public Map<String,List<Person>> findAll(){
    List <Person> list = new ArrayList<>();
    list.add(new Person("1", "Charlie");
    list.add(new Person("2", "Mary");
    LinkedHashMap<String,List<Person>> map = new LinkedHashMap<>();
    map.put("person", list);
    return map;
}

answered Feb 11, 2016 at 21:24

wero

33.1k3 gold badges63 silver badges87 bronze badges

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

2 Comments

CyborgNinja23 Over a year ago

Sorry, but now I'm getting this error:

HTTP Status 500 - Internal Server Error. The server encountered an internal error that prevented it from fulfilling this request.

wero Over a year ago

@CyborgNinja23 search the log files for a stack trace

Mr Lister · Accepted Answer · 2016-02-19 20:07:29Z

1

Wrap the List<Person> in a class with a single field:

public class PersonResponse {

    private List<Person> person = new ArrayList<Person>();

    public PersonResponse(List<Person> person) {
        this.person = person;
    }

}

And change your REST method to:

public PersonResponse findAll(){
    List <Person> result = new ArrayList<>();
    result.add(new Person("1", "Charlie");
    result.add(new Person("2", "Mary");
    return new PersonResponse(result);
    }
}

edited Feb 19, 2016 at 20:07

Mr Lister

46.8k15 gold badges118 silver badges156 bronze badges

answered Feb 12, 2016 at 7:48

morsor

1,32314 silver badges32 bronze badges

1 Comment

CyborgNinja23 Over a year ago

For some reason, when I wrap it in this class, it gives me the 'Status 500 - Internal Server Error'

Collectives™ on Stack Overflow

REST - Define name for JSON array from Restful Java Service

2 Answers 2

2 Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related