...
- The parameter folderId defines all lists (folders) to add the bookmark.
- Duplicates for folderIds are not possible because of using a set.
- The folderId favorites is always used. If no folderId is specified, only favorites is used.
- If the folder favorites not exists, because a new user adds the first bookmark, then the folder favorites is created.
...
| Name | Value | Occurence | Default | Mandatory |
|---|---|---|---|---|
| folderIds | ID of folder(s) | Multiple | - | Yes, at least one id |
Response payload
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"id": "rjzgAIgBdHmpxQQKvQHm",
"itemId": "IVMX3IRHKU725WR2HHT6VY2AFFS72FGK",
"description": "My important description",
"userId": "fachstelle_museum",
"type": "CULTURAL_ITEM",
"createdAt": 1683641908448,
"updatedAt": 1683641908448,
"keywordTool": {
"done": True
}
} |
...
- 200 = Bookmark created
- 400 = Item Id is missing (required) or at least one folder id is missing
- 401 = User is not authorized
- 500 = Internal server error
...
- UC01 | Create bookmark
- The user selects an object from an object list as a favorite.
- The user selects an object from an object list as a favorite.
Example call(s)
...
- Create bookmark in main folder and two additional folders
- POST https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/bookmarks?folderIds=Sjszo4cBdHmpxQQKUvah&folderIds=rjwQKYgBdHmpxQQKKgSs
...