...
FA10 | Retrieve folders
GET | /favourites/folders |
|---|
...
Free access to published DDB folders and all NEWSPAPER folders
Login required for user folder
Remarks
- Endpoint could be used in 3 usage modes.
Usage modes
| Mode | Description | Usage | Authentification |
|---|---|---|---|
| Institution | Search for folders of an institution in DDB (without login) | Only use institution param (portal DDB is fixed) | no Login |
| Public | Search for public DDB folders (without login) | Use no param (portal is not used) | |
| User | Search user folders (with login) | Use params userId/portal/title alone or in combination |
Query parameters
| Name | Value | Occurence | Default | Required |
|---|---|---|---|---|
| userId | ID of user | Once | - | At least userId or title required |
| portal | Name of used portal | Once | DDB | Optional for DDB, for other portals required |
| title | Title of folder | Once | - | At least userId or title required |
| institution | ID of institution | Once | - | Only ID of institution |
| offset | Beginn offset of results | Once | 0 (Solr default is used) | Optional |
| size | Size data of results | Once | 10 (Solr default is used) | Optional |
...
POST | /favourites/folders/{id} |
|---|
User permission required
Remarks
- Only DDB portal: The folder favorites is protected and could not be modified.
...
DELETE | /favourites/folders/{id} |
|---|
User permission required
Remarks
- Only DDB portal: The folder favorites is protected and could not be deleted here.
...
DELETE | /favourites/folders/{id}/bookmarks/{bookmarkId} |
|---|
User permission required
Remarks
- The folder ID and bookmark ID must exist before deleting something.
- Only for DDB portal:A bookmark could not be deleted from the main folder (favorites), because this is done only if the bookmark is deleted (see Delete Bookmark).
...
DELETE | /favourites/folders |
|---|
User permission required
Remarks
- This endpoint deletes all stored bookmarks and folders from a user for every portal.
...
POST | /favourites/download |
|---|
User permission required
Remarks
- Only valid formats are possible. If an invalid format will be used, then the request will rejected with 400 Bad Request.
...
GET | /favourites/folders/public |
|---|
Remarks
- This endpoint needs no authentificated user.
- The query only searches for folders with given institution id.
...
- Model object to hold a bookmark (= favorites)
Remarks
- The possible types of a bookmark are:
- CULTURAL_ITEM | INSTITUTION | ENTITY | NEWSPAPER | ARTICLE
...