...

/favourites/folders/public

Remarks

• This endpoint needs no authentificated user.
• The endpoint works in two modes:
  • Mode 1: You set an institution and it searches for it.
  • Mode 2: You set no institution and it searches only for published folders (for the given portal).

Query parameters

...

• Retrieve folders by user
  • GET https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/folders/public

^ Back to top

...

FA17 | Retrieve public folder

/favourites/folders/public/{id}

Remarks

• This endpoint needs no authentificated user.
• Only published folders could be returned. If folder is private (not published) a 401 status is returned.

Response payload

{
	"id": "73611165cc142ae53176707d5a92e8f3"
	"portal": "DDB",
	"title": "favorites",
	"description": "Das ist ein Test!",
	"userId": "DDB",
	"publishingName": "xxx",
	"createdAt": 1682070216141,
	"updatedAt": 1683642142482,
	"bookmarksIds": [
		"MESR_IcBosJ3rUWzhkJj",
		"rjzgAIgBdHmpxQQKvQHm"
	],
	"institutionIds": [
		"MESR_IcBosJ3rUWzhkJj"
	],
	"blockingToken": "Test",
	"blocked": true,
	"published": true,
	"keywordTool": {
		"sentToAdmin": false
	}
}

Status codes

• 200 = Folder found
• 401 = Folder is private (and could not be returned)
• 404 = Folder not exist
• 500 = Internal server error

Related Use Case(s)

• All info of a public list is retrieved to display it in the frontend.

Example call(s)

• Retrieve folder
  • GET https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/folders/public/ZjxwJIsBdHmpxQQKjyxB

^ Back to top

...

FA18 | Retrieve bookmarks of a public folder

/favourites/folders/pubic/{id}/bookmarks

Remarks

• This endpoint needs no authentificated user.
• Only published folders could be returned. If folder is private (not published) a 401 status is returned.

Response payload

{
	"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
			},
		}
	]
}

Status codes

• 200 = Folder found
• 401 = Folder is private (and could not be returned)
• 404 = Folder not exist
• 500 = Internal server error

Related Use Case(s)

• Retrieve bookmarks of a public list
  • Any user retrieves bookmarks of a specified public list.
    

Example call(s)

• Retrieve bookmarks of folder
  • GET https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/folders/public/vJ2GGYsBYUgoK0Rzg70n/bookmarks

^ Back to top

...

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

...