Versions Compared

Key

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

...

  • Endpoint could be used in 3 usage modes.

Usage modes

ModeDescriptionUsage
Authentification
Login required
InstitutionSearch for folders of an institution in DDB (without login)Only use institution param (portal DDB is fixed)
no Login
No
PublicSearch for public DDB folders (without login)Use no param (portal is not used)No
UserSearch user folders (with login)Use params userId/portal/title alone or in combinationYes

Query parameters

NameValueOccurenceDefaultRequired
userIdID of userOnce-At least userId or title required
portalName of used portalOnceDDBOptional for DDB, for other portals required
titleTitle of folderOnce-At least userId or title required
institutionID of institutionOnce-Only ID of institution
offsetBeginn offset of resultsOnce0 (Solr default is used)Optional
sizeSize data of resultsOnce10 (Solr default is used)Optional

...