...
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. | - | | | |||||
• | | | Return information about | | | - | | | |||
• | | | Return entities according to relation and parameters specified | | - | Contains entities selected and sorted in conformance to request parameters. For more details see description of | | ||||
• | | | Return a list of all ancestor communities of the | | | | |||||
• | | | Returns a list of immediate sub-communities (children) of the | | | | |||||
• | | | Return a list of collections in the | | | | |||||
• | | | Return a list of recent submissions to a community. | | | | |||||
• | | | Return a community logo | | - | - | Contains community logo (bitstream) | | |||
• | | | Return a list of all collections in the system. | - | Contains item count, identifiers, name and handle of collections, or 204 if | | |||||
• | | | Return information about | | Contains id, name, handle, members, member groups of submitters, licence, metadata, templateitem | | | | |||
• | | | Return a list of all ancestor communities a collection with | | | | |||||
• | | | Returns a list of all items from the collection | | | | |||||
• | | | Return a collection logo | | - | - | Contains collection logo (bitstream) | |
...
Code | Description |
---|---|
200 | OK |
201 | Created |
204 | No content |
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
404 | Not found |
405 | Method not allowed |
500 | Internal server error |
503 | Service unavailable |
Repository manipulation
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Response Data | Formats | Response codes |
---|---|---|---|---|---|---|---|---|
• • | | | Change description of | - | | Response code | | 200, 400, 401, 403, 500 |
• • | | | Add community to the system | | | | | 200, 400, 401, 403, 500 |
• | | | Delete community from the system | - | - | Response code | | 200, 400, 401, 403, 500 |
• | | | Change description of | |
| Response code | | 200, 400, 401, 403, 500 |
• | | | Add collection to the system | |
| | | 200, 400, 401, 403, 500 |
• | | | Delete collection from the system | - | - | Response code | | 200, 400, 401, 403, 500 |
...
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| | | Return detailed information about an item. | | - | | | | 200, 204, 400, 500 | ||||||||||||||
| | Contains an information about an item including resource name, metadata, owning collection, collections stored in, communities stored in, bundle ids, last modified date, archival/withdrawn status and submitter of an item. | | 200, 204, 400, 500 |
| |
| Return status of user permissions on this item. | | - | | Boolean variable, stating can user edit the listed item. | | 200, 400, 500 | |||||||||
| | | Return communities this item is part of. | - | - | | | | 200, 400, 500 | ||||||||||||||
| | | Return collections this item is part of. | - | - | | | - | | Communities listed. | | 200, 400, 500 | |
| | | Return collections this item is part of. | - | - | | Collections listed. |
| 200, 400, 500 |
| | | Returns bitstream object - usually the library item file. | | - | - | Returns bitstream object - usually the library item file. | | - | - | | | 200, 400, 401, 403, 404, 500 | ||||||||||
| | | Returns checksum of bitstream . |
| - | - | Checksum of Returns bitstream . | | 200, 400, 401, 403, 404, 500 |
...
Comment: In this case it is not clear how to treat recent
part of endpoint. If we stick to semantic mapping, then it should look like /resource/id/mapping
, but recent
in this case obviously do not represent a mapping, but the property.
Comment #2: Semantic mapping presented in this case should be probably hardcoded for 1.x branch, but on abstraction level which enables easy replacement with some auto-discovery method prepared for 2.x and eventually backported to 1.x. This way we would be able to call something similar to /communities/id
or communities/id/capabilities
in order to get supported mappings (amongst other data).
...
Parameter
...
Description
...
returns only top level communities
...
Integration in the system
It is planned to consult two external subjects for cooperation and the assistance during integration process (LMS and national library internal automation process). More information coming soon - awaiting approval of other parties.
...