...
- Retrieve bookmark
- GET https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/bookmarks/YzxuJIsBdHmpxQQKPSya
...
FA03 | Retrieve bookmarks
...
GET | /favourites/bookmarks |
|---|
User permission required
...
- Download ZIP
- POST https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/download
FA16 | Retrieve public folders (Deprecated)
...
GET
...
/favourites/folders/publicRemarks
- This endpoint needs no authentificated user.
- The query only searches for folders with given institution id.
Query parameters
...
Response payload
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"query": "institution:"*"",
"total": 2,
"offset": 0,
"size": 9999,
"folders": [
{
"id": "Sjszo4cBdHmpxQQKUvah",
"portal": "NEWSPAPER",
"title": "Schiller 1",
"description": "",
"userId": "af43fc5bfa951c88e8e4b4574b39a65a",
"publishingName": "hosc",
"createdAt": 1682070262371,
"updatedAt": 1683642142787,
"bookmarksIds": ["MUSR_IcBosJ3rUWzmkLU"],
"institutionIds": ["SV27RQJTWNOLJTNSG3ASNZSGNHBITQI2"],
"blockingToken": "",
"keywordTool": {
"sentToAdmin": false
},
"blocked": false,
"published": true
},
{
"id": "rjwQKYgBdHmpxQQKKgSs",
"portal": "NEWSPAPER",
"title": "Schiller 2",
"description": "",
"userId": "af43fc5bfa951c88e8e4b4574b39a65a",
"publishingName": "hosc",
"createdAt": 1682070216141,
"updatedAt": 1683642142482,
"bookmarksIds": [],
"institutionIds": ["SV27RQJTWNOLJTNSG3ASNZSGNHBITQI2"],
"blockingToken": "",
"keywordTool": {
"sentToAdmin": false
},
"blocked": true,
"published": true
}
]
} |
Status codes
- 200 = Folder(s) found
- 400 = Missing search param(s)
- 500 = Internal server error
Example call(s)
- Retrieve public folders
- GET https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/folders/public
...
API calls for Use Cases
...
- Model object to hold a bookmark (= favorites)
Remarks
- The possible types of a bookmark are:
- CULTURAL_ITEM | INSTITUTION | ENTITY | NEWSPAPER | ARTICLE
...