...
- introduction of new method
- extending of existing method, by implementing new functionality (e.g. GET/PUT/DELETE)
- extending of existing method, by changing its parameters, output etc
Note title Naming convention for endpoints DSpace 1.x and 2.x are treating the resources on different way. 2.x is more generalized, suggesting the use of RDF-like interrelation notations. The necessity to follow this approach for 1.x is to be discussed in the list or on the following page.
Repository browsing
Name and description
Value and notes
Base URI:
/communities?topLevelOnly=true&idOnly=false
Description:
Returns a list of all communities on the system or return just top level communities.
HTTP method:
GETOptional parameters:
Sorting fields supported:
id, name, countitems: sorting by id, community name and item countResponse formats:
json,xmlStatus codes
200: OK
204: no content
400: bad request
500: internal server errorResponse details
Name and description | Value and notes |
|---|---|
Base URI: | /communities/{id}/parents?idOnly=false&immediateOnly=true |
Description: | Returns a list of all parent communities of the |
HTTP method: | |
Optional parameters: |
|
Sorting fields supported: | |
Response formats: | |
Status codes | 200: OK |
Response details |
|
...
Name and description | Value and notes |
|---|---|
Base URI: | |
Description: | Returns general statistics |
HTTP method: | |
Response formats: | |
Status codes | 200: OK |
Response details | Returns cummulative list of statistics data for the system currently available |
Items ingestion
Administrative tasks
Workflow related tasks
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.
Documentation tasks
Although provided software module exposes basic documentation automatically to the end user, in order to make it easier for other developers and users the documentation in the following forms is additionaly to be provided:
- Confluence pages, current location
- integrated documentation in PDF form (manual)
- short slides containing technology overview, advocacy/facts, configuration and usage guideliens and examples
- code will be additionally commented
Example of usage
At the end of the current stage of this project as a bonus task (if time constraints allow) the examples of usage will be provided for several languages, the use-cases will be presented (example of integration in other software, e.g. LMS) and optionally simple client system demonstrating UI customization will be demonstrated (e.g. Flex or JavaFX like).