...
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 entities according to relation and parameters specified | property | type |
|
|
|
|
• | | | 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 |
Mandatory parameters
Parameter | Description | Values | Example |
---|---|---|---|
property | Return entities satisfying requested property relation | ds:isPartOfSite | |
|
|
|
|
|
|
|
|
Note: incomplete/orientative properties, for more info check Vocabularies.
Optional parameters:
Parameter | Description | ||||||
---|---|---|---|---|---|---|---|
topLevelOnly | returns only top level communities | ||||||
idOnly | if true return only the identifiers for the record |
...