...
API endpoints
FA01 | Create bookmark
POST | /favourites/bookmarks |
|---|
User permission required
Remarks
...
{
"id": "rjzgAIgBdHmpxQQKvQHm", // Not used
"itemId": "IVMX3IRHKU725WR2HHT6VY2AFFS72FGK", // Required
"description": "My important description", // Optional
"userId": "fachstelle_museum", // Not used
"type": "CULTURAL_ITEM", // Required
"createdAt": 1683641908448, // Not used
"updatedAt": 1683641908448, // Not used
"keywordTool": { // Optional
"done": true
}
}Remarks
Response payload
Returns Bookmark JSON object:
...
- Create bookmark in only main folder
- GET https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/bookmarks
- Create bookmark in main folder and two additional folders
- GET https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/bookmarks?folderIds=Sjszo4cBdHmpxQQKUvah&folderIds=rjwQKYgBdHmpxQQKKgSs
...
FA02 | Retrieve bookmark
POST | /favourites/bookmarks |
|---|
User permission required
Remarks
...
FA03 | Retrieve bookmarks
GET | /favourites/bookmarks |
|---|
User permission required
Remarks
...
FA04 | Update bookmark
PUT | /favourites/bookmarks/{id} |
|---|
User permission required
Remarks
...
FA05 | Delete bookmark
DELETE | /favourites/bookmarks/{id} |
|---|
User permission required
Remarks
...
FA06 | Create folder
POST | /favourites/folders |
|---|
User permission required
Remarks
...
FA07 | Add bookmark to folder
POST | /favourites/{id}/bookmarks |
|---|
User permission required
Remarks
...
FA08 | Retrieve folder
GET | /favourites/folders/{id} |
|---|
User permission required
Remarks
...
FA09 | Retrieve bookmarks of a folder
GET | /favourites/folders/{id}/bookmarks |
|---|
User permission required
Remarks
...
FA10 | Retrieve folders
GET | /favourites/folders |
|---|
User permission required
Remarks
...
FA11 | Update folder
POST | /favourites/folders/{id} |
|---|
User permission required
Remarks
...
FA12 | Delete folder
DELETE | /favourites/folders/{id} |
|---|
User permission required
Remarks
...
FA13 | Delete bookmark from folder
DELETE | /favourites/folders/{id}/bookmarks/{bookmarkId} |
|---|
User permission required
Remarks
...
FA14 | Delete all bookmarks and folders
DELETE | /favourites/folders/{id} |
|---|
User permission required