...
| Name | Value | Occurence | Default | MandatoryRequired |
|---|---|---|---|---|
| folderIds | ID of folder(s) | Multiple | - | Yes, at least one idfolderId |
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
}
} |
...
| Name | Value | Occurence | Default | Required |
|---|---|---|---|---|
| userId | ID of user | Once | - | At least userId or one itemId required |
| itemIds | IDs of items | Multiple | - | At least userId or one itemId required |
| offset | Offset of result | Once | -1 | - |
| size | Length of result | Once | -1 | - |
Response payload
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"query": "user:"73611165cc142ae53176707d5a92e8f3",
"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
},
}
]
} |
...
| Name | Value | Occurence | Default | Required |
|---|---|---|---|---|
| bookmarkId | ID of bookmark to add | Once | - | Yes |
Status codes
- 200 = Bookmarks added
- 400 = Bookmark ID not exist
- 401 = User is not authorized
- 404 = Folder ID not exist
- 500 = Internal server error
...
| Name | Value | Occurence | Default | Required |
|---|---|---|---|---|
| userId | ID of user | Once | - | At least userId or title required |
| portal | Name of used portal | Once | DDB | - |
| title | Title of folder | Once | - | At least userId or title required |
| offset | Beginn offset of results | Once | -1 | - |
| size | Size data of results | Once | -1 | - |
Response payload
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"query": "user:"73611165cc142ae53176707d5a92e8f3"",
"total": 19,
"offset": 0,
"size": 9999,
"folders": [
{
"id": "Sjszo4cBdHmpxQQKUvah",
"portal": "DDB",
"title": "Schiller",
"description": "",
"userId": "fachstelle_museum",
"publishingName": "dio",
"createdAt": 1682070262371,
"updatedAt": 1683642142787,
"bookmarksIds": ["MUSR_IcBosJ3rUWzmkLU"],
"institutionIds": Null,
"blockingToken": "",
"keywordTool": {
"sentToAdmin": false
},
"blocked": false,
"published": true},
{
"id": "rjwQKYgBdHmpxQQKKgSs",
"portal": "DDB",
"title": "favorites",
"description": "Das ist ein Test!",
"userId": "fachstelle_museum",
"publishingName": "xxx",
"createdAt": 1682070216141,
"updatedAt": 1683642142482,
"bookmarksIds": [],
"institutionIds": none,
"blockingToken": "Test",
"keywordTool": {
"sentToAdmin": false
},
"blocked": true,
"published": true
}
]
} |
...
| Name | Value | Occurence | Default | Required |
|---|---|---|---|---|
| userId | ID of user to delete | Once | - | Yes |
Status codes
- 200 = Bookmarks and Folders deleted
- 401 = User not authorized
- 404 = User ID not found
- 500 = Internal server error
...