Page History

...

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

The list of communities containing respective fields .

Response code details:
204 - if there are no communities on the system

json
xml

200, 204, 400, 500

•

GET

/communities/{id}

Return information about id community.

id

idOnly=false

-

Fields describing community.

json
xml

200, 400, 404, 500

•

GET

/communities/{id}/{element}

Return a particular data field found in the community id

Anchor

	com_elements
	com_elements

Fields supported (for element):
id - entity identifier, internal to the system
name - entity name
countItems - number of items under community
handle - handle of the community (unique persistent resource identifier)
type - entity type (object type in the system)
collections - collections contained in the community, ordered by id
canedit - states user persmission on the community (editing)
anchestor - anchestors of the community
children - subcommunities, ordered by id
administrators - group administrators, ordered by id
recent - recent items in the community
shortDescription - short description
copyrightText - copyright text
sidebarText - sidebar text
introductoryText - introductory text

id

idOnly=false
immediateOnly=true

id
name
countitems

Respective field info

json
xml

200, 204, 400, 500

•

GET

/communities/{id}/logo

Return a community logo

id

-

Contains community logo (bitstream)

binary

200, 400

•

GET

/collections

Return a list of all collections in the system.

-

idOnly=false
isAuthorized=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.

The list of the collections containing respective fields.

Response code details:
204 - if there are no communities on the system

json
xml

200, 204, 400, 500

•

GET

/collections/{id}

Return information about id collection

id

idOnly=false

id
name
countitems

Fields of the collection entity (detailed elements) .

json
xml

200, 204, 400, 500

•

GET

/collections/{id}/{element}

Return a particular data field found in the collection id.

Anchor

	col_elements
	col_elements

Fields supported (for element):
id - entity identifier, internal to the system
name - collection name
licence - collection licence
items - items contained in collection
handle - handle of the collection (unique persistent resource identifier)
canedit - states user permission on the collection (edit)
communities - communities collection is a part of
countItems - number of the items in the collection
type - entity type (object type in the system)
shortDescription - short description of the collection
introText - introductory text for the collection
copyrightText - copyright text for the collection
sidebarText - sidebar text for the collection
provenance - provenance

id

idOnly=false
immediateOnly=true

id
name
countitems

Respective field info

json
xml

200, 204, 400, 500

...

C	Verb	URL	Description	Mandatory parameters	Optional parameters	Response Data	Formats	Response codes
•	`PUT`	`/communities/{id}/{element`}	Change description of of `element` describing `id` community	`id, {{element`}}	- `name` `metadata` `logo`	Response code	`json` `xml`	200, 400, 401, 403, 500
•	`POST`	`/communities` Add community to the system	Action to be done under community `id`, adding new content or values. Supported actions: `createAdministrators` `createCollection` `createSubcommunity`	`id` - `name` `logo` `parent` other metadata `name`	-	`Id` of newly created communityentity, depending on the action selected.	`json` `xml`	200, 400, 401, 403, 500
•	`DELETE`	`/communities/{id`}	Delete community from the system	`id`	-	Response code	`json` `xml`	200, 400, 401, 403, 500
•	`DELETE`	`/communities/{id}/administrators`	Remove the administrators group from the community	`id`	-	Response code	`json` `xml`
•	`DELETE`	`/communities/{id}/collections/{cid`}	Remove collection `cid` from community `id`	`id`	`cid`	Response code
•	`DELETE`	`/communities/{id}/children/{cid`}	Remove subcommunity `cid` from community `id`	`id`	`cid`	Response code
•	`POST`	`/communities/{id}/administrators`	Create a default administrators group if one does not already exists	`id`	-	`Id` of newly created group
•	`POST`	`/communities/{id}/collections`	Create a new collection within community `id`	`id`	-	`Id` of newly created collection
•	`PUT`	`/communities/{id}/collections/{cid`}	Add an existing collection `cid` to community `id`	`id` `cid`	--	Response code
•	`POST`	`/communities/{id}/children`	Create a new subcommunity within community `id`	`id`	-	`Id` of newly created subcommunity
•	`PUT`	`/communities/{id}/children/{cid`}	Add an existing community `cid` as a subcommunity of community `id`	`id` `cid`	-	Response code
	`PUT`	`/communities/{id}/metadata`	Set metadata value	`id`	`metadataField` `metadataValue`	Response code
•	`PUT`	`/collections/{id`}	Change description of `id` collection	`id`		Response code	`json` `xml`	200, 400, 401, 403, 500
•	`POST`	`/collections`	Add collection to the system	`name` `communityId`		`Id` of newly created collection	`json` `xml`	200, 400, 401, 403, 500
•	`DELETE`	`/collections/{id`}	Delete collection from the system	-	-	Response code	`json` `xml`	200, 400, 401, 403, 500
	`DELETE`	`/collections/{id}/items/{cid`}	Delete item `cid` from collection `id`	`id`	`cid`	Response code	`json` `xml`
	`PUT`	`/collections/{id}/logo`	Set the logo for collection `id`	`id`		Response code
	`POST`	`/collections/{id}/administrators`	Create a default administrators group if one does not already exists	`id`	-	Response code
	`DELETE`	`/collections/{id}/administrators`	Remove the administrators group from the collection	`id`	-	Response code
	`PUT`	`/collections/{id}/submitters`	Create a default submitters group if one does not already exists	`id`	-	Response code
	`DELETE`	`/collections/{id}/submitters`	Remove the submitters group	`id`	-	Response code
	`PUT`	`/collections/{id}/templateitem`	Create an empty template item for this collection	`id`	-	Response code
	`DELETE`	`/collections/{id}/templateitem`	Remove the template item from the collection	`id`	-	Response code
	`POST`	`/collections/{id}/items`	Add an item to the collection	`id`	`itemId`	Response code
	`PUT`	`/collections/{id}/metadata`	Set metadata value	`id`	`metadataField` `metadataValue`	Response code
	`PUT`	`/collections/{\id}/licence`	Set collection licence	`id`	`licence`	Response code

...

Page tree

Versions Compared

Old Version 121

New Version 122

Key