...
| Name | Value | Occurence | Default | Required |
|---|---|---|---|---|
| bookmarkId | ID of bookmark to add | Once | - | Yes |
Response payload
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"id": "TC07____________FL01",
"index": "folder",
"statusCode": 200,
"result": "updated"
} |
Status codes
- 200 = Bookmark added
- 400 = Bookmark ID not exist
- 401 = User is not authorized
- 404 = Folder ID not exist
- 500 = Internal server error
...
GET | /favourites/folders/{id} |
|---|
User permission required
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
}
} |
...
GET | /favourites/folders/{id}/bookmarks |
|---|
User permission required
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
},
}
]
} |
...
| Name | Value | Occurence | Default | Required |
|---|---|---|---|---|
| userId | ID of user | Once | - | At least userId or title required |
| portal | Name of used portal | Once | DDB | Optional for DDB, for other portals required |
| title | Title of folder | Once | - | At least userId or title required |
| offset | Beginn offset of results | Once | -1 | Optional |
| size | Size data of results | Once | -1 | Optional |
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
}
]
} |
...
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"id": "Sjszo4cBdHmpxQQKUvah", // Not used
"portal": "DDB", // Required
"title": "favorites", // Optional
"description": "Das ist ein Test!", // Optional
"userId": "fachstelle_museum", // Not used
"publishingName": "xxx", // Optional
"createdAt": 1682070216141, // Not used
"updatedAt": 1683642142482, // Not used
"bookmarksIds": [ // Optional
"MESR_IcBosJ3rUWzhkJj",
"rjzgAIgBdHmpxQQKvQHm"
],
"institutionIds": [ // Optional
"MESR_IcBosJ3rUWzhkJj"
],
"blockingToken": "Test", // Optional
"blocked": true, // Optional
"published": true, // Optional
"keywordTool": { // Optional
"sentToAdmin": false
}
} |
Response payload
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"id": "Sjszo4cBdHmpxQQKUvah",
"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
}
} |
...
- Only DDB portal: The folder favorites is protected and could not be deleted here.
Response payload
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"id": "TC12____________FL01",
"index": "folder",
"statusCode": 200,
"result": "deleted"
} |
...
- 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).
Response payload
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"id": "TC13____________FL01",
"index": "folder",
"statusCode": 200,
"result": "updated"
} |
...
| Name | Value | Occurence | Default | Required |
|---|---|---|---|---|
| userId | ID of user to delete | Once | - | Yes |
Response payload
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"took": 0,
"errors": false,
"result": [
{
"id": "TC14____________BM02",
"index": "bookmark",
"statusCode": 200,
"result": "deleted"
},
{
"id": "TC14____________BM01",
"index": "bookmark",
"statusCode": 200,
"result": "deleted"
},
{
"id": "TC14____________FL01",
"index": "folder",
"statusCode": 200,
"result": "deleted"
},
{
"id": "TC14____________FL02",
"index": "folder",
"statusCode": 200,
"result": "deleted"
},
{
"id": "TC14____________FL03",
"index": "folder",
"statusCode": 200,
"result": "deleted"
},
{
"id": "TC14____________FL04",
"index": "folder",
"statusCode": 200,
"result": "deleted"
}
],
"statusCode": 200,
"statusMessage": "All folders and bookmarks for user <jean_paul> deleted"
} |
...