Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Remarks

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

...

  • 200 = Folder(s) found
  • 400 = Missing search param(s)
  • 500 = Internal server error

Example call(s)

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

...

Remarks

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

...

  • 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 infos of a public list is retrieved to display it in the frontend.

Example call(s)

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

...

Remarks

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

...

Example call(s)

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

...