...

• The parameter folderIds defines folders for adding the new created bookmark.
• In portal DDB the folderId favorites must always used.

Query parametersparameters 

...

• 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

/favourites/download

User permission required

Remarks

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

Request payload

{
    "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 https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/download

^ 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

...