...
Free access to published DDB folders and all NEWSPAPER folders
Login required for user folders
Remarks
- Endpoint could be used in 3 usage modes
Usage modes
| Mode | Description | Login required |
|---|---|---|
| DDB | Retrieve published DDB folder | No |
| Newspaper | Retrieve any Newspaper folder | No |
| User | Retrieve user folder | Yes |
Response payload
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"id": "73611165cc142ae53176707d5a92e8f3"
"portal": "DDB",
"title": "favorites",
"description": "Das ist ein Test!",
"userId": "fachstelle_museum",
"publishingName": "xxx",
"createdAt": 1682070216141,
"updatedAt": 1683642142482,
"bookmarksIds": [
"MESR_IcBosJ3rUWzhkJj",
"rjzgAIgBdHmpxQQKvQHm"
],
"institutionIds": [
"MESR_IcBosJ3rUWzhkJj"
],
"blockingToken": "Test",
"blocked": true,
"published": true,
"keywordTool": {
"sentToAdmin": false
}
} |
...
Free access to published DDB folders and all NEWSPAPER folders
Remarks
- Endpoint could be used in 3 usage modes
Usage modes
| Mode | Description | Login required |
|---|---|---|
| DDB | Retrieve bookmarks of published DDB folder | No |
| Newspaper | Retrieve bookmarks of any Newspaper folder | No |
| User | Retrieve bookmarks of an user folder | Yes |
Response payload
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"query": "user:"73611165cc142ae53176707d5a92e8f3" AND folder:"p0Qyo4cBosJ3rUWznjiY"",
"total": 4,
"offset": 0,
"size": 9999,
"bookmarks": [
{
"id": "rjzgAIgBdHmpxQQKvQHm",
"itemId": "IVMX3IRHKU725WR2HHT6VY2AFFS72FGK",
"description": "",
"userId": "fachstelle_museum",
"type": "CULTURAL_ITEM",
"createdAt": 1683641908448,
"updatedAt": 1683641908448,
"keywordTool": {
"done": False
},
},
{
"id": "nDxWtIgBdHmpxQQKNxNQ",
"itemId": "IVMX3IRHKU725WR2HHT6VY2AFFS72FGK",
"description": "Neues Lesezeichen",
"userId": "fachstelle_museum",
"type": "CULTURAL_ITEM",
"createdAt": 1683641908448,
"updatedAt": 1683641908448,
"keywordTool": {
"done": False
},
}
]
} |
...
Free access to published DDB folders and all NEWSPAPER folders
Remarks
- Endpoint could be used in 3 usage modes
Usage modes
| Mode | Description | Possible params | Login required |
|---|---|---|---|
| Institution | Search folders by a DDB institution | Only institution used | No |
| Public | Search published DDB folders | Params not used | No |
| User | Search user folders | Any combination of userId/portal/title | Yes |
...
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
...