Page History

...

Earlier Implementation Description - GSoC09

topLevelOnlyidOnly

C	Verb	URL	Description	Mandatory parameters	Optional parameters	Sorting fields	Response Data	Formats	Response codes
	`GET`	`/communities`	Returns a list of all communities on the system or return just top level communities.	-	`topLevelOnly=true` `idOnly=false`	`id` `name` `countitems`	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.	`json` `xml`	200, 400, 500
Parameter	Description
Anchor
toplevelonly	toplevelonly	returns only top level communities
Anchor
idonly	idonly	if true return only the identifiers for the record

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

	`GET`	`/communities/{id`}	Return information about `id` community.	-	-	-	TBD	`json` `xml`	200, 204, 400, 500
•	`PUT`	`/communities/{id`}	Change description of `id` community	`name`	-	-	TBD	`json` `xml`	200, 204, 500, 501
•	`POST`	`/communities`	Add community to the system	`name`	`logo` `parrent` other metadata	-	TBD	`json` `xml`	200, 201, 204, 500, 501
	`GET`	`/communities/{id}/parents`	Return a list of all parent communities of the `id` community.	-	idOnly=false immediateOnly=true	`id` `name` `countitems`
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. id is already top-level. Additionaly, based on parameter idOnly=true the method returns only identifiers.
Name and description	Value and notes
	`json` `xml`	200, 204, 400, 500
	`GET` Base URI:	`/communities/{id}/`collections?idOnly=false	Description:	`children`	Returns a list of collections in 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, collection name and item count
Response formats:	`json`, `xml`
.	-	idOnly=false	`id` `name` `countitems`	Contains item count, identifiers, handle and name or 204 if none. Additionaly, based on parameter `idOnly=true` the method returns only identifiers.	`json` `xml`	200, 204, 400, 500
	`GET`	`/communities/{id}/collections`	Return a list of collections in the `id` community.	-	idOnly=false	`id` `name` `countitems`	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.	`json` `xml`	200, 204, 400, 500

Parameter

Description

Anchor

	toplevelonly
	toplevelonly

topLevelOnly

returns only top level communities

Anchor

	idonly
	idonly

idOnly

if true return only the identifiers for the record

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.

...

Page tree

Versions Compared

Old Version 31

New Version 32

Key