Skip to content
dimus edited this page Feb 11, 2013 · 2 revisions

Communities

Returns a list of communities in the system with their full info included.

Additionaly it is possible to exclude detailed information and get only IDs, using idOnly=true in query.

Supported methods: GET

Supported parameters:

- idOnly=false: return only id if true

- topLevelOnly=true: return only top level communities

- Other fields supported (see main dspace-rest description): _start, _limit, _page, _perpage

- Sorting fields supported (see main dspace-rest description): id, name, countitems

Sample Entity URLs (_id=‘:ID:’) [may not be valid]:

Entity Collection URL: GET /communities.xml

Response Code Details: 200 plus data; 204 if there is no content; 400 for bad request (e.g. no entities); 500 for internal server error (e.g. problem with SQL connection)

Receive list of communities

Show Entity URL: GET /communities/:ID:.xml

Response Code Details: 200 plus data; 404 if not found, 400 for bad request (e.g. no entity, wrong parameters), 500 for internal server error (e.g. problem with SQL connection)

Receive info on particular community defined by id

Data and Request Handling

Output format : xml