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 | 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
administrators - default group of administrators
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 | - | 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
administrators - default group of administrators
| json
xml | 200, 400, 404, 500 |
• | GET | /communities/{id}/ancestors {element}{}
| Return a list of all ancestor communities of the id community. particular data field found in the community {id}
Fields supported:
{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 item (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 | 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
| json
xml | 200, 204, 400, 500 |
• | GET | /communities/{id}/children | Returns a list of immediate sub-communities (children) of the id community. | id | idOnly=false | id
name
countitems | 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
administrators - default group of administrators
| json
xml | 200, 204, 400, 500 |
• | GET | /communities/{id}/collections | Return a list of collections in the id community. | id | idOnly=false | id
name
countitems | 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
templateItem - template item
Response code details:
204 - if there are no collections | json
xml | 200, 204, 400, 500 |
• | GET | /communities/{id}/recent | Return a list of recent submissions to a community. | id | idOnly=false | id
name
lastmodified
submitterId
submitterName | id - entity (item) identifier, internal to the system
handle - handle of the item
isArchived - archival status of the item
isWithdrawn - withdrawal status of the item
lastModified - timestamp of last modification
metadata - item metadata
name - item name
submitter - submiter entity
type - entity type (object type in the system, item in this case)
bitstreams - bitstreams related to the item
bundles - bundles related to the item
collections - collections related item appear in
communities - communities related item appear in
Response details:
204 - if there are no recently submitted items | 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. | json
xml | 200, 204, 400, 500 |
• | GET | /collections/{id} | Return information about id collection | id | idOnly=false | id
name
countitems | countitems - number of items under collection
items - items present in the collection
id - entity (collection) identifier, internal to the system
handle - handle of the collection
licence - collection licence
name - collection name
type - entity type (object type in the system, item in this case)
communities - communities related collection appear in
submiters - default group of submitters, if there is one
administrators - default group of administrators, if there is one
templateitem - template item for collection, if there is one
| json
xml | 200, 204, 400, 500 |
• | GET | /collections/{id}/ancestors
| Return a list of all ancestor communities a collection with id belongs to.
| id | idOnly=false
immediateOnly=true
| id
name
countitems
| 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
administrators - default group of administrators
| json
xml | 200, 204, 400, 500 |
• | GET | /collections/{id}/items
| Returns a list of all items from the collection id.
| id | idOnly=false
inArchive=false
| id
name
lastmodified
submitterId
submitterName | id - entity (item) identifier, internal to the system
handle - handle of the item
isArchived - archival status of the item
isWithdrawn - withdrawal status of the item
lastModified - timestamp of last modification
metadata - item metadata
name - item name
submitter - submiter entity
type - entity type (object type in the system, item in this case)
bitstreams - bitstreams related to the item
bundles - bundles related to the item
collections - collections related item appear in
communities - communities related item appear in
Response details:
204 - if there are no items
| json
xml
| 200, 204, 400, 500
|
• | GET | /collections/{id}/logo | Return a collection logo | id | - | - | Contains collection logo (bitstream) | binary | 200, 400 |