Page History

...

ParametertopLevelOnlyidOnly

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
	`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`	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.	`json` `xml`	200, 204, 400, 500
	`GET`	`/communities/{id}/children`	Returns a list of immediate sub-communities (children) of the `id` community.	-	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`	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
	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/`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
`GET`	`/communities/{id}/recent`	Return a list of recent submissions to a community.	-	idOnly=false	`id` `name` `lastmodified` `submitter`	Contains complete items from recent submissions in community. Additionaly, contains only identifiers when `idOnly=true` is used.	`json` `xml`	200, 204, 400, 500
	`GET`	`/collections`	Return a list of all collections in the system.	-	idOnly=false	`id` `name` `countitems`	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.	`json` `xml`	200, 204, 400, 500
	`GET`	`/collections/{id}/communities`	Return a list of all communities a collection with `id` belongs to.	-	idOnly=false	`id` `name` `countitems`	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.	`json` `xml`	200, 204, 400, 500
	`GET`	`/collections/{id}/items`	Returns a list of all items from the collection `id`.	-	idOnly=false in_archive=false	`id` `name` `lastmodified` `submitter`	Contains full information info including name, submitter, collections related or 204 if there are
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 return only identifiers of collectionsresults.
Name and description	Value and notes
`json` `xml`	200, 204, 400, 500

Parameter

Description

Anchor

	toplevelonly
	toplevelonly

topLevelOnly

returns only top level communities

Anchor

	idonly
	idonly

idOnly

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.

...

Content searching

C	Verb	URL	Description	Mandatory parameters	Optional parameters	Sorting fields	Response Data	Formats	Response codes
	`GET`	`/search`	Return a list of all objects found by searching criteria. Notice: community and collection are mutually exclusive options.	-	TBD modifiers{{query=`query`}}&(community=`id` or {{collection=`id`}}	`idOnly=false`	`id` `name` `lastmodified` `submitter`	Item info with basic metadata for the search results. Additionally return only identifiers when `idOnly=true` is used.	`json` `xml`	200, 204, 400, 500

Name and description	Value and notes
Base URI:	/search?query=`query`&(community=`id`!collection=`id`)&idOnly=false
Description:	Returns a list of all objects found by searching criteria
HTTP method:	`GET`
Optional parameters:	`query`: string query for searching, without query method behaves like browsing with additional sorting/ordering capabilities community=`id`: the id of community limiting search to collection=`id`: the id of collection limiting search to Notice: community and collection are mutually exclusive options idOnly=false: using true returns only identifiers of the results
Sorting fields supported:	`id, name, lastmodified, submitter`: sorting by id, name, last modifed date or submitter of item
Sorting/ordering modifiers:	`title, issueDate, author, subject, submitter`
Response formats:	`json`, `xml`
Status codes	200: OK 204: no content 400: bad request 500: internal server error
Response details	Item info with basic metadata for the search results. Additionally return only identifiers when idOnly=true is used.

...

Page tree

Versions Compared

Old Version 32

New Version 33

Key

Content searching