Earlier Implementation Description - GSoC09

This is the list of methods/endpoints implemented in earlier development stage.

Name and description	Value and notes
Base URI:	`/communities?topLevelOnly=true&idOnly=false`
Description:	Returns a list of all communities on the system or return just top level communities.
HTTP method:	`GET`
Optional parameters:	`topLevelOnly=true`: returns only top level communities `idOnly=false`: if true return only the identifiers for the record, by default return the full record
Sorting fields supported:	`id, name, countitems`: sorting by id, community name and item count
Response formats:	`json`, `xml`
Status codes	200: OK 204: no content 400: bad request 500: internal server error
Response details	By default contains item count, identifier, handle and name and other referencing data, or 204 if none. Additionaly, based on parameter idOnly=true the method returns only identifiers.

Name and description	Value and notes
Base URI:	/communities/{id}/parents?idOnly=false&immediateOnly=true
Description:	Returns a list of all parent communities of the `id` community.
HTTP method:	`GET`
Optional parameters:	idOnly=false: if true return only the identifiers for the record, by default return the full record immediateOnly=true: if false then return all parents for this community, by default return only the immediate parents
Sorting fields supported:	`id, name, countitems`: sorting by id, community name and item count
Response formats:	`json`, `xml`
Status codes	200: OK 204: no content 400: bad request 500: internal server error
Response details	Contains item count, identifiers, handle and name or 204 if id is already top-level. Additionaly, based on parameter idOnly=true the method returns only identifiers.

Name and description	Value and notes
Base URI:	/communities/`id`/children?idOnly=false
Description:	Returns a list of immediate sub-communities (children) of the `id` community.
HTTP method:	`GET`
Optional parameters:	idOnly=false: if true return only the identifiers for the record, by default return the full record
Sorting fields supported:	`id, name, countitems`: sorting by id, community name and item count
Response formats:	`json`, `xml`
Status codes	200: OK 204: no content 400: bad request 500: internal server error
Response details	Contains item count, identifiers, handle and name or 204 if none. Additionaly, based on parameter idOnly=true the method returns only identifiers.

Name and description	Value and notes
Base URI:	/communities/`id`/collections?idOnly=false
Description:	Returns a list of collections in the `id` community
HTTP method:	`GET`
Optional parameters:	idOnly=false: if true return only the identifiers for the record, by default return the full record
Sorting fields supported:	`id, name, countitems`: sorting by id, collection name and item count
Response formats:	`json`, `xml`
Status codes	200: OK 204: no content 400: bad request 500: internal server error
Response details	Contains item count, identifiers, name, archival status, last modification and handle of collections, or 204 if there are none of them. Additionaly with idOnly=true only identifiers are returned.

Name and description	Value and notes
Base URI:	/communities/`id`/recent?idOnly=false
Description:	Returns a list of recent submissions to a community
HTTP method:	`GET`
Optional parameters:	idOnly=false: if true return only the identifiers for the record, by default return the full record
Sorting fields supported:	`id, name, lastmodified, submitter`: sorting by id, name(title), last modified date and submitter(name) of item
Response formats:	`json`, `xml`
Status codes	200: OK 204: no content 400: bad request 500: internal server error
Response details	Contains complete items from recent submissions in community. Additionaly, contains only identifiers when idOnly=true is used.

Name and description	Value and notes
Base URI:	/collections?idOnly=false
Description:	Returns a list of all collections in the system
HTTP method:	`GET`
Optional parameters:	idOnly=false: if true return only the identifiers for the record, by default return the full record
Sorting fields supported:	`id, name, countitems`: sorting by id, collection name and item count
Response formats:	`json`, `xml`
Status codes	200: OK 204: no content 400: bad request 500: internal server error
Response details	Contains item count, identifiers, name and handle of collections, or 204 if there are none of them. In the case idOnly=true is used, returns only identifiers of collections.

Name and description	Value and notes
Base URI:	/collections/`id`/communities?idOnly=false
Description:	Returns a list of all communities a collection with `id` belongs to
HTTP method:	`GET`
Optional parameters:	idOnly=false: if true return only the identifiers for the record, by default return the full record
Sorting fields supported:	`id, name, countitems`: sorting by id, community name and item count
Response formats:	`json`, `xml`
Status codes	200: OK 204: no content 400: bad request 500: internal server error
Response details	Contains item count, identifier, name and handle of collections, or 204 if there are none of them. Additionaly, when idOnly=true is used, return only identifiers.

Name and description	Value and notes
Base URI:	/collections/`id`/items?idOnly=false&in_archive=false
Description:	Returns a list of all items from the collection `id`
HTTP method:	`GET`
Optional parameters:	idOnly=false: if true, return only identifiers of result records in_archive=false: defines should it return in_archive items only or all items if true
Sorting fields supported:	`id, name, lastmodified, submitter`: sorting by id, name, lastmodified date and submitter of item
Response formats:	`json`, `xml`
Status codes	200: OK 204: no content 400: bad request 500: internal server error
Response details	Contains full information info including name, submitter, collections related or 204 if there are none of them In the case idOnly=true is used, return only identifiers of results.

Page tree