Skip to end of metadata
Go to start of metadata

Methods of the API

The Application Programming Interface (API) of the Deutsche Digitale Bibliothek does have 15 methods, which provide different kind of data. These are in detail...

binary

The method binary returns the content of a binary file of an item for a given item-ID. This method provides response data as application/octet-stream. A binary file at DDB can be a picture, a tumbnail of a picture, a video clip, an audio file etc. It is a read-only service and must be accessed with a HTTP-GET-request.

entities

The method entities is providing access to the the Lucene search index of entities used at DDB. This method provides response data only as application/json. It is a read-only service and must be accessed with a HTTP-GET-request.

institutions

The method institutions returns a list of institutions which are registered at the DDB. This method provides response data only as application/json. It is a read-only service and must be accessed with a HTTP-GET-request.

  • sectorsThe method sectors returns the list of available institution sectors at the DDB. Each sector contains a name in the property value and the number of institutions that belong to this sector (count). As institutions can belong to multiple sectors, the overall sum of the different counts can be higher than the total number of institutions. This method provides response data only as application/json. It is a read-only service and must be accessed with a HTTP-GET-request.

items

  • aipThe method aip returns the Archive Information Package (AIP) of an item for a given item-ID. An AIP contains all available information of an item including a persistent identifier. This method provides response data as application/json and application/xml. It is a read-only service and must be accessed with a HTTP-GET-request.
  • binariesThe method binaries returns a list of binary data files related to an item for a given item-ID. Binary data can be accessed with the binary method. The binaries method provides response data as application/json and application/xml. It is a read-only service and must be accessed with a HTTP-GET-request.
  • childrenThe method children returns metadata of these items which are related to the inquired item and which are one level deeper (child item) in the hierarchy than the inquired item. The child items will be sorted according to the position field of the hierarchy nodes. If the position is the same the label will be used for sorting. The provided metadata can be empty if the item does not have any child items. This method provides response data as application/json and application/xml. It is a read-only s
  • edmThe method edm returns the Europeana Data Model (DDB profile) of an item for a given item-ID. This method provides response data as application/json and application/xml. It is a read-only service and must be accessed with a HTTP-GET-request.
  • indexing-profileThe method indexing-profile returns the profile of an item for a given item-ID, which was used for the indexing process. This method provides response data as application/json and application/xml. It is a read-only service and must be accessed with a HTTP-GET-request.
  • parentsThe method parents returns item-IDs of these items which are related to the inquired item and which are one or more levels higher (parent, grandparent ... item) in the hierarchy than the inquired item. This means that all parent items up to the root item will be provided. The provided metadata can be empty if the item does not have any parent items. This method provides response data as application/json and application/xml. It is a read-only service and must be accessed with a HTTP-GET-request.
  • sourceThe method source returns the initial XML metadata of an item for a given item-ID. The format can be one of the accepted input data formats (e.g. MARCXML, METS/MODS, LIDO, Dublin Core). This method provides response data only as application/xml because the DDB only accept XML-based metadata from its contributing institutions. It is a read-only service and must be accessed with a HTTP-GET-request.
  • viewThe method view returns the view of an item for a given item-ID. A view is the data set a frontend page at DDB is based on. This method provides response data as application/json and application/xml. It is a read-only service and must be accessed with a HTTP-GET-request.

search

The method search is providing an interface to the search engine of the DDB. This method provides response data only as application/json. It is a read-only service and must be accessed with a HTTP-GET-request. dd

  • facetsThe method facets of search returns all available facets or all available facets of a specific type. This method provides response data only as application/json. It is a read-only service and must be accessed with a HTTP-GET-request.
  • organizationThe method search/organization is providing access to the the Lucene search index of organizations used at DDB. This method provides response data only as application/json. It is a read-only service and must be accessed with a HTTP-GET-request.
  • sortcriteriaThe method sortcriteria of search returns the available sort criteria and the default criterion of the search result sets. This method provides response data only as application/json. It is a read-only service and must be accessed with a HTTP-GET-request.
  • suggestThe method suggest of search returns suggestions for a given query. This method provides response data only as application/json. It is a read-only service and must be accessed with a HTTP-GET-request.

  • No labels
Page: binary Page: entities Page: institutions Page: items Page: search