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. | - | - | - | Contains information about community, including id, handle, name, collections, ancestors, subcommunities, administrators, metadata | countitems - number of items under community
handle - handle of the community (unique persistent resource identifier)
id - entity identifier, internal to the system
name - entity name
type - entity type (object type in the system)
collections - collections contained in the community, ordered by id
ancestors - ancestors of the community, ordered by id
children - subcommunities, ordered by id
admins - group administrators, ordered by id
metadata - community metadata
Response code details:
204 - if there are no communities on the system | json
xml | 200, 204, 400, 500 |
• | GET | /communities/{id} /relations | Return entities according to relation and parameters specified | property
| rtype
rfield | - | Contains entities selected and sorted in conformance to request parameters | json
xml | 200, 204, 400, 500 | information about id community. | - | idOnly=false | - | countitems - number of items under community
handle - handle of the community (unique persistent resource identifier)
id - entity identifier, internal to the system
name - entity name
type - entity type (object type in the system)
collections - collections contained in the community, ordered by id
ancestors - ancestors of the community, ordered by id
children - subcommunities, ordered by id
admins - group administrators, ordered by id
metadata - community metadata | • | GET | /communities/{id}/ancestors | 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.
| json
xml | 200, 204400, 400404, 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.
relations
| Return entities according to relation and parameters specified | property
| rtype
rfield | - | Contains entities selected and sorted in conformance to request parameters. For more details see description of rtype and rfield. | json
xml | 200, 204, | json
xml | 200, 204, 400, 500 |
• | GET | /communities/{id}/collectionsancestors | Return a list of collections in all ancestor communities of the id community. | - | idOnly=false
immediateOnly=true | id
name
countitems | 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
submitterId
submitterName | Contains complete items from recent submissions in community.
Additionaly, contains only identifiers when idOnly=true is used. | - number of items under community
handle - handle of the community (unique persistent resource identifier)
id - entity identifier, internal to the system
name - entity name
type - entity type (object type in the system)
collections - collections contained in the community, ordered by id
ancestors - ancestors of the community, ordered by id
children - subcommunities, ordered by id
admins - group administrators, ordered by id
metadata - community metadata
| json
xml | 200, 204, 400, 500 |
• | GET | /communities/{id}/logochildren | Return a community logo | - | - | - | Contains community logo (bitstream) | binary | 200, 400 | • | GET | /collections | Return a list of all collections in the system Returns a list of immediate sub-communities (children) of the id community. | - | 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. | json
xml | 200, 204, 400, 500 | countitems - number of items under community
handle - handle of the community (unique persistent resource identifier)
id - entity identifier, internal to the system
name - entity name
type - entity type (object type in the system)
collections - collections contained in the community, ordered by id
ancestors - ancestors of the community, ordered by id
children - subcommunities, ordered by id
admins - group administrators, ordered by id
metadata - community metadata | • | GET | /collections/{id} | Return information about id collection | - | idOnly=false | id
name
countitems | Contains id, name, handle, members, member groups of submitters, licence, metadata, templateitem
| json
xml | 200, 204, 400, 500 |
• | GET | /collectionscommunities/{id}/ancestorscollections | Return a list of all ancestor communities a collection with id belongs tocollections in the id community. | - | 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.
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. | countitems - number of items under collection
handle - handle of the collection
id - entity identifier, internal to the system
name - entity name
type - entity type (object type in the system)
items - items contained in the collection, ordered by id
communities - owners of the collection, ordered by id
admins - group administrators, ordered by id
licence - collection licence metadata
templateItem - template item
Response code details:
204 - if there are no collections | json
json
xml | 200, 204, 400, 500 |
• | GET | /collectionscommunities/{id}/itemsrecent | Returns Return a list of all items from the collection idrecent submissions to a community. | - | idOnly=false inArchive=false
| id
name
lastmodified
submitterId
submitterName | 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 resultscomplete items from recent submissions in community.
Additionaly, contains only identifiers when idOnly=true is used. | json
xml | 200, 204, 400, 500 |
• | GET | /collectionscommunities/{id}/logo | Return a collection community logo | - | - | - | Contains collection 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. | json
xml | 200, 204, 400, 500 |
• | GET | /collections/{id} | Return information about id collection | - | idOnly=false | id
name
countitems | Contains id, name, handle, members, member groups of submitters, licence, metadata, templateitem | 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.
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
inArchive=false
| id
name
lastmodified
submitterId
submitterName | 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
|
• | GET | /collections/{id}/logo | Return a collection logo | - | - | - | Contains collection logo (bitstream) | binary | 200, 400 |