Skip to end of metadata
Go to start of metadata

Description

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.
Content of this page

Request Header

NameValue(s)RequiredRepeatableDefault valueDescription
Acceptapplication/json
*/*
yesnoapplication/jsonSpecifies the format of the accepted data. Every request needs to be sent with a valid Accept Header defining the requested response format. Otherwise the response to the request will be a 406 - Not acceptable status code. If the request accepts every kind of data (Accept: */*) JSON will be returned.
AuthorizationOAuth oauth_consumer_key="<API key>"yesnoAn API key is mandatory for data access. You may enclose it by either sending it as Query Parameter or (as mentioned here) in the Request Header.
Hostapi.deutsche-digitale-bibliothek.deyesnoThe host is mandatory.

Parameters

Query

ParameterValue(s)RequiredRepeatableDefault valueDescription
facet<facet name>noyesThis is the name of a facet which will be taken into account. Only facets which are supplied via a query parameter will be included into the result.
<facet_name><query string>noyesThe value of a query parameter named like a valid, existing facet defines a search query on the given facet name. It allows to reduce the result by certain values of facets.
facet.limit<number>nonoLimits the number of values of a facet to the given amount.
minDocs<number>nonoThe amount of documents a facet must exceed to be included in the result set.
oauth_consumer_key<API key>yesnoAn API key is mandatory for data access. You may enclose it by either sending it as Query Parameter or (as mentioned here) in the Request Header.
offset<number>nonoThis is the number of the first entry of the result.
query<query string>yesno*:*Term(s) to be searched. Must be URL-encoded and compliant to the SOLR Query Syntax.
rows <number>nonoThis is the count of result entries to be shown in total.
sort<restricted values>nono

Defines the sorting order, which can be one of the following values. It requires the query parameter, otherwise the sort is always random_<seed>.

  • ALPHA_ASC
  • ALPHA_DESC
  • RANDOM_<seed>
  • RELEVANCE

Authorization

This method needs an API key for authentication (Who are you?) and authorization (What you are authorized to do?). For more information please read the Authorization How-To.

This method is offered over HTTP and HTTP Secure.

Errors

CodeTextDescription
404Not FoundEither the item does not exist or has no data.
406Not AcceptableThe Request Header is not acceptable. Please see section Request Header.
500Server ErrorSomething went terribly wrong. An error message will provide a meaningful description.

Samples

Request 1

Search for all entities on the entity index.

Response

XML  Expand source

Request 2

Search for all entities of type person.

Response

JSON  Expand source

Request 3

Search for the entity with the identifier http://d-nb.info/gnd/118540238.

Response

JSON  Expand source

Request 4

Search for all entities which contain the term frank in any field and value Bauingenieur in the facet person_occupation_fct.

Response

JSON  Expand source

 

 

 

 

 

  • No labels