API endpoints

FA01 | Create bookmark

POST	/favourites/bookmarks

...

The parameter folderIds defines folders for adding the new created bookmark.
The JSON properties itemId and (bookmark) type must exist.
In portal DDB the folderId favorites must always used.

Query parametersparameters

Name	Value	Occurence	Default	Required
folderIds	ID of folder(s)	Multiple	-	Yes, at least one folderId

Request payload

Code Block

theme	Midnight
title	Bookmark object
linenumbers	true
collapse	true

 {
	"id": "rjzgAIgBdHmpxQQKvQHm",						// Not used
	"itemId": "IVMX3IRHKU725WR2HHT6VY2AFFS72FGK",		// Required
	"description": "My important description",			// Optional
	"userId": "fachstelle_museum",					 	// Not used
	"type": "CULTURAL_ITEM",							// OptionalRequired
	"createdAt": 1683641908448,							// Not used
	"updatedAt": 1683641908448,							// Not used
	"keywordTool": {									// Optional
		"done": True
	}
}

...

Create bookmark in two folders (If DDB the favorites folder must be one of the folderIds)
- POST https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/bookmarks?folderIds=Sjszo4cBdHmpxQQKUvah&folderIds=rjwQKYgBdHmpxQQKKgSs

^ Back to top

...

FA02 | Retrieve bookmark

GET	/favourites/bookmarks/{id}

...

Retrieve bookmark
- GET https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/bookmarks/YzxuJIsBdHmpxQQKPSya

^ Back to top

...

FA03 | Retrieve bookmarks

...

GET	/favourites/bookmarks

...

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	Optional
size	Length of result	Once	-1	Optional

Response payload

Code Block

theme	Midnight
title	Bookmark result object
linenumbers	true
collapse	true

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

...

Retrieve all bookmarks by user
- GET https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/bookmarks?userId=fachstelle_museum
Retrieve all bookmarks by user and item ids
- GET https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/bookmarks?userId=fachstelle_museum&itemIds=itemId________________________01

^ Back to top

...

FA04 | Update bookmark

PUT	/favourites/bookmarks/{id}

...

Update bookmark
- PUT https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/bookmarks/YzxuJIsBdHmpxQQKPSya

^ Back to top

...

FA05 | Delete bookmark

DELETE	/favourites/bookmarks/{id}

...

Code Block

theme	Midnight
title	Bookmark objectResponse
linenumbers	true
collapse	true

{
    "took": 11,
    "errors": false,
    "result": [
        {
            "id": "TC05____________BM01",
            "index": "bookmark",
            "statusCode": 200,
            "result": "deleted"
        }
    ],
    "statusCode": 200,
    "statusMessage": null
}

...

Delete bookmark
- DELETE https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/bookmarks/ZTxuJIsBdHmpxQQKUSwX

^ Back to top

...

FA06 | Create folder

POST	/favourites/folders

...

Code Block

theme	Midnight
title	Folder object
linenumbers	true
collapse	true

{
	"id": "73611165cc142ae53176707d5a92e8f3",	// Not used
    "portal": "DDB",							// Required | Allowed values are: DDB or NEWSPAPER
    "title": "favorites",						// Required
	"description": "Das ist ein Test!",			// Optional
	"userId": "fachstelle_museum",				// Not used
	"publishingName": "xxx",					// Optional
	"createdAt": 1682070216141,					// Not used
	"updatedAt": 1683642142482,					// Not used
	"bookmarkIds": [							// Optional
		"MESR_IcBosJ3rUWzhkJj",
		"rjzgAIgBdHmpxQQKvQHm"
	],
	"institutionIds": [							// Optional
		"MESR_IcBosJ3rUWzhkJj"
	],
	"blockingToken": "Test",					// Optional
	"blocked": true,							// Optional
	"published": true,							// Optional
	"keywordTool": {							// Optional
		"sentToAdmin": false
	}
}

...

200 = Folder created
400 = Title attribute Property title is missing or Portal attribute Property portal is wrongunkown
401 = User is not authorized
409 = Folder already exists
500 = Internal server error

...

Create folder
- POST https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/folders

^ Back to top

...

FA07 | Add bookmark to folder

POST	/favourites/folders/{idfolderId}/bookmarks

Remarks

Only DDB portal: A bookmark could not be added to the main folder (favorites), because it is added to this folder when you create a bookmark.
The folder ID and bookmark ID must exist before adding something.

...

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

Related Use Case(s)

UC02 | Assign bookmarks to selected lists
- A user stores bookmarks (additionally) in personal lists.
UC08 | Copy bookmarks from All Favorites to personal lists
- A user copies bookmarks into personal lists.
UC14 | Copy bookmarks to another personal list
- A user copies bookmarks from a personal list to other personal lists.

Example call(s)

Response payload

Code Block

theme	Midnight
title	Response
linenumbers	true
collapse	true

{
    "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

Related Use Case(s)

UC02 | Assign bookmarks to selected lists
- A user stores bookmarks (additionally) in personal lists.
UC08 | Copy bookmarks from All Favorites to personal lists
- A user copies bookmarks into personal lists.
UC14 | Copy bookmarks to another personal list
- A user copies bookmarks from a personal list to other personal lists.

Example call(s)

Add bookmark to folder
- POST https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/folders/ZjxwJIsBdHmpxQQKjyxB/bookmarks?bookmarkId=ZTxuJIsBdHmpxQQKUSwX

^ Back to top

...

FA08 | Retrieve folder

GET	/favourites/folders/{id}

Response payload

Remarks

Endpoint could be used in 3 usage modes

Usage modes

Mode	Description	Login required
DDB	Retrieve published DDB folder	No
Newspaper	Retrieve any Newspaper folder	No
User	Retrieve user folder	Yes

Response payload

Code Block

theme	Midnight
title	Folder object
linenumbers	true
collapse	true

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

...

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

^ Back to top

...

FA09 | Retrieve bookmarks of a folder

GET	/favourites/folders/{id}/bookmarks

Response payload

Remarks

Endpoint could be used in 3 usage modes

Usage modes

Mode	Description	Login required
DDB	Retrieve bookmarks of published DDB folder	No
Newspaper	Retrieve bookmarks of any Newspaper folder	No
User	Retrieve bookmarks of an user folder	Yes

Response payload

Code Block

linenumbers
theme	Midnight
title	BookmarkResult object

Code Block

theme	Midnight
title	BookmarkResult object
linenumbers	true
collapse	true

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

...

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

^ Back to top

...

FA10 | Retrieve folders

GET	/favourites/folders

Query parameters

Remarks

Endpoint could be used in 3 usage modes

Usage modes

Mode	Description	Possible params	Login required
Institution	Search folders by a DDB institution	Only institution param used	No
Public	Search published DDB folders	Params not used	No
User	Search user folders	Any combination of userId/portal/title	Yes

Query parameters

else

Name	Value	Occurence	Default	Required
userId
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
institution	ID of institution	Once	-	Only ID of institution
offset	Beginn offset of results	Once-1	0 (Solr default is used)	Optional
size	Size data of results	Once-1	10 (Solr default is used)	Optional

Response payload

Code Block

theme	Midnight
title	FolderResult object
linenumbers	true
collapse	true

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

...

200 = Folder(s) found
400 = Missing some search paramsparam(s)
401 = User not authorized
500 = Internal server error

...

UC03 | Listennamen eines Benutzers abrufen
- The user retrieves bookmarks of a specified list.

Example call(s)

Retrieve folder folders by user
- GET https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/folders?userId=fachstelle_museum&portal=DDBNEWSPAPER
Retrieve folder folders by user and title
- GET https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/folders?userId=fachstelle_museum&portal=DDB&title=favorites

^ Back to top

...

FA11 | Update folder

POST	/favourites/folders/{id}

Remarks

Only DDB portal: The folder favorites is protected and could not be modified.

Request payload

Code Block

theme	Midnight
title	Folder object
linenumbers	true
collapse	true

 {
	"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

theme	Midnight
title	Folder object
linenumbers	true
collapse	true

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

Status codes

200 = Folder updated
400 = Folder favorites could not be modified (Only for DDB portal)
401 = User not authorized
404 = Folder ID not found
500 = Internal server error

...

Update folder
- POST https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/folders/wJ2JGYsBYUgoK0RzI71_

^ Back to top

...

FA12 | Delete folder

DELETE	/favourites/folders/{id}

Status codes

Remarks

Only DDB portal: The folder favorites is protected and
200 = Folder deleted
400 = Folder favorite could not be deleted
401 = User not authorized
404 = Folder ID not found
500 = Internal server error

Related Use Case(s)

UC11 | Remove personal list with bookmarks
- The user deletes a personal list with the contained bookmarks.

Example call(s)

Delete folder
- DELETE https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/folders/wJ2JGYsBYUgoK0RzI71_

^ Back to top

FA13 | Delete bookmark from folder

...

DELETE

...

/favourites/folders/{id}/bookmarks/{bookmarkId}

here.

Response payload

Code Block

theme	Midnight
title	Response
linenumbers	true
collapse	true

{
    "id": "TC12____________FL01",
    "index": "folder",
    "statusCode": 200,
    "result": "deleted"
}

Status codes

200 = Folder deleted
400 = Folder favourites could not be deleted (Only for DDB portal)

Remarks

A bookmark could not be deleted from the main folder (favorites), because this is done only if the bookmark is deleted (see Delete Bookmark).
The folder ID and bookmark ID must exist before deleting something.

Status codes

200 = Bookmark in Folder deleted
400 = Bookmark ID not found
401 = User not authorized
404 = Folder ID not found
500 = Internal server error

Related Use Case(s)

UC11 | Remove personal list with bookmarks
- The user deletes
FA13 | Delete bookmark from list
- A bookmark is removed from a personal list with the contained bookmarks.

Example call(s)

Delete bookmarks from folder
- DELETE https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/folders/wJ2JGYsBYUgoK0RzI71_/bookmarks/vp2GGYsBYUgoK0Rzh71c

^ Back to top

FA14 | Delete all bookmarks and folders

...

DELETE

...

/favourites/folders

Query parameters

...

FA13 | Remove bookmark from folder

DELETE	/favourites/folders/{id}/bookmarks/{bookmarkId}

Remarks

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

theme	Midnight
title	Response
linenumbers	true
collapse	true

{
    "id": "TC13____________FL01",
    "index": "folder",
    "statusCode": 200,
    "result": "updated"
}

Status codes

200 = Bookmark in Folder deleted
400 = Bookmark ID not found
Only for DDB portal:Folder ID of favourites is used.
401 = User not authorized
404 = Folder ID not found
500 = Internal server error

Related Use Case(s)

FA13 | Delete bookmark from list
A bookmark is removed from a personal list.

Example call(s)

Delete bookmarks from folder
DELETE https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/folders/wJ2JGYsBYUgoK0RzI71_/bookmarks/vp2GGYsBYUgoK0Rzh71c

^ Back to top

...

FA14 | Delete all bookmarks and folders

DELETE	/favourites/folders

Remarks

This endpoint deletes all stored bookmarks and folders from a user for every portal.

Query parameters

Name	Value	Occurence	Default	Required
userId	ID of user to delete	Once	-	Yes

Response payload

Code Block

theme	Midnight
title	Response
linenumbers	true
collapse	true

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

Status codes

200 = Bookmarks and Folders deleted
401 = User not authorized
404 = No folders found for given User ID
500 = Internal server error

Related Use Case(s)

A user deletes his account. Then the system first deletes all bookmarks in all lists of the user. Then all lists including favorites are deleted.

Example call(s)

Delete all bookmarks and folders
DELETE https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/folders?userId=fachstelle_museum

^ Back to top

...

FA15 | Download newspaper pages as ZIP

POST	/favourites/download

Remarks

Only valid formats are possible. If an invalid format will be used, then the request will rejected with 400 Bad Request.

Request payload

Code Block

theme	Midnight
title	DownloadRequest object
linenumbers	true
collapse	true

{
    "bookmarkIds": [
        "TC15____________BM01",
        "TC15____________BM02",
        "TC15____________BM03",
        "TC15____________BM04",
        "TC15____________BM05",
        "TC15____________BM06"
    ],
    "formats": [
        "TXT", "CSV", "ALTO", "IMAGE"     
	]
}

Response payload

ZIP file with requested formats:
ALTO: Delivers ALTO files for every selected newspaper
IMAGE: Delivers images for every selected newspaper
TXT: Delivers text files with fulltext for every selected newspaper page
CSV: Delivers one CSV summary for all pages

Status codes

200 = ZIP successfully created and delivered
400 = No valid bookmark id found (invalid IDs will be skipped)
401 = User not authorized
500 = Internal server error

Example call(s)

Download ZIP
POST

Status codes

200 = Bookmarks and Folders deleted
401 = User not authorized
404 = User ID not found
500 = Internal server error

Related Use Case(s)

A user deletes his account. Then the system first deletes all bookmarks in all lists of the user. Then all lists including favorites are deleted.

Example call(s)

Delete all bookmarks and folders
DELETE https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/folders?userId=fachstelle_museumdownload

^ 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

...

Page tree

Page History

Versions Compared

Old Version 56

New Version Current

Key

API endpoints

FA01 | Create bookmark

Query parametersparameters

Request payload

FA02 | Retrieve bookmark

FA03 | Retrieve bookmarks

GET/favourites/bookmarksUser permission required...NameValueOccurenceDefaultRequireduserIdID of userOnce-At least userId or one itemId requireditemIdsIDs of itemsMultiple-At least userId or one itemId requiredoffsetOffset of resultOnce-1OptionalsizeLength of resultOnce-1Optional

Response payload

FA04 | Update bookmark

FA05 | Delete bookmark

FA06 | Create folder

FA07 | Add bookmark to folder

Remarks

Status codes

Related Use Case(s)

Example call(s)

Response payload

Status codes

Related Use Case(s)

Example call(s)

FA08 | Retrieve folder

Response payload

Remarks

Usage modes

Response payload

FA09 | Retrieve bookmarks of a folder

Response payload

Remarks

Usage modes

Response payload

FA10 | Retrieve folders

Query parameters

Remarks

Usage modes

Query parameters

Response payload

Example call(s)

FA11 | Update folder

Remarks

Request payload

Response payload

Status codes

FA12 | Delete folder

Status codes

Remarks

Related Use Case(s)

Example call(s)

FA13 | Delete bookmark from folder

Response payload

Status codes

Remarks

Status codes

Related Use Case(s)

Example call(s)

FA14 | Delete all bookmarks and folders

Query parameters

FA13 | Remove bookmark from folder

Remarks

Response payload

Status codes

Related Use Case(s)

Example call(s)

FA14 | Delete all bookmarks and folders

Remarks

Query parameters

Response payload

Status codes

Related Use Case(s)

Example call(s)

FA15 | Download newspaper pages as ZIP

Remarks

Request payload

Response payload

Status codes