...
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes |
|---|---|---|---|---|---|---|---|---|---|
| | | Returns a list of all communities on the system or return just top level communities. | - | | | By default contains item count, identifier, handle and name and other referencing data, or 204 if none. Additionaly, based on parameter | | 200, 400, 500 |
| | | Return information about | - | - | - | TBD | | 200, 204, 400, 500 |
• | | | Return a list of all ancestor communities of the | - | idOnly=false | | 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. | | 200, 204, 400, 500 |
• | | | Returns a list of immediate sub-communities (children) of the | - | idOnly=false | | Contains item count, identifiers, handle and name or 204 if none. Additionaly, based on parameter | | 200, 204, 400, 500 |
• | | | Return a list of collections in the | - | idOnly=false | | 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. | | 200, 204, 400, 500 |
• | | | Return a list of recent submissions to a community. | - | idOnly=false | | Contains complete items from recent submissions in community. | | 200, 204, 400, 500 |
| | | Return a list of all collections in the system. | - | idOnly=false | | Contains item count, identifiers, name and handle of collections, or 204 if | | 200, 204, 400, 500 |
• | | | Return a list of all ancestor communities a collection with | - | idOnly=false | | Contains item count, identifier, name and handle of collections, or 204 if | | 200, 204, 400, 500 |
| | | Returns a list of all items from the collection | - | idOnly=false | | 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. | | 200, 204, 400, 500 |
Optional parameters:
Parameter | Description | ||||||
|---|---|---|---|---|---|---|---|
topLevelOnly | returns only top level communities | ||||||
idOnly | if true return only the identifiers for the record |
Sorting fields:
Parameter | Description | Ordering supported | ||||||
|---|---|---|---|---|---|---|---|---|
id | sort results by entity id | asc | ascending | ||||||
name | sort results by entity name | asc | ascending | ||||||
countitems | sort results by number of items contained | asc | ascending |
Controling results:
Parameter | Description | Default | Example |
|---|---|---|---|
_start | position of the first entity to return | 0 (first) | _start=5 to list 6th item and onwards |
_page | page of data to display | 0 (first) | _page=2, to display second page with query results |
_perpage | number of results to show on each page | 0 (all) | _perpage=10 to display 10 results per page |
_limit | maximum number of entities to return | 0 (all) | _limit=50 |
_sort | the sort order to return entities in | ascending default | _sort=name |
Repository manipulation
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Response Data | Formats | Response codes |
|---|---|---|---|---|---|---|---|---|
• | | /communities/{id} | Change description of | name | - | TBD | | 200, 204, 400, 500 |
• | | | Add community to the system | name | | TBD | | 200, 204, 400, 500 |
...