Page History

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.
Order of communities is ???

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
parent
other metadata

-

TBD

json
xml

200, 201, 204, 500, 501

GET

/communities/{id}/ds:isPartOf

Return a list of all ancestor 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.
Order of ancestors is ??? immediate first or most distant first?

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.
Order of children is ???

json
xml

200, 204, 400, 500

GET

/communities/{id}/collections

Return a list of collections in the id community.

-

idOnly=false

id
name
countitems

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

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}/ancestors

Return a list of all ancestor communities a collection with id belongs to.

-

idOnly=false
immediateOnly=true

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 none of them. In the case idOnly=true is used, return only identifiers of results.

json
xml

200, 204, 400, 500

returns only top level communities

if true return only the identifiers for the record