Description

The 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.
GET /search/facets?<QueryParameters> HTTP/1.1

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.

Back To Top

Parameters

Query

ParameterValue(s)RequiredRepeatableDefault valueDescription
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.
type<restricted values>nono

Type of the returned facets, which can be

  • EXTENDED
  • SEARCH
  • TECHNICAL

Back To Top

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.

Back To Top

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.

Back To Top

Samples

Request 1

GET /search/facets?oauth_consumer_key=abcdefgh12345678 HTTP/1.1
Host: api.deutsche-digitale-bibliothek.de
Accept: application/json

Response

 [
   {
      "name":"time_fct",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"ENUM",
      "sortType":"ALPHA_ID",
      "displayType":"SEARCH",
      "position":1
   },
   {
      "name":"place_fct",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"TEXT",
      "sortType":null,
      "displayType":"SEARCH",
      "position":2
   },
   {
      "name":"affiliate_fct",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"TEXT",
      "sortType":null,
      "displayType":"SEARCH",
      "position":3
   },
   {
      "name":"affiliate_fct_involved",
      "parent":"affiliate_fct",
      "paths":[

      ],
      "role":"involved",
      "searchType":"TEXT",
      "sortType":null,
      "displayType":"TECHNICAL",
      "position":-1
   },
   {
      "name":"affiliate_fct_subject",
      "parent":"affiliate_fct",
      "paths":[

      ],
      "role":"subject",
      "searchType":"TEXT",
      "sortType":null,
      "displayType":"TECHNICAL",
      "position":-1
   },
   {
      "name":"keywords_fct",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"TEXT",
      "sortType":null,
      "displayType":"SEARCH",
      "position":4
   },
   {
      "name":"language_fct",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"ENUM",
      "sortType":"ALPHA_LABEL",
      "displayType":"SEARCH",
      "position":5
   },
   {
      "name":"type_fct",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"ENUM",
      "sortType":"ALPHA_LABEL",
      "displayType":"SEARCH",
      "position":6
   },
   {
      "name":"sector_fct",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"ENUM",
      "sortType":"ALPHA_LABEL",
      "displayType":"SEARCH",
      "position":7
   },
   {
      "name":"provider_fct",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"ENUM",
      "sortType":null,
      "displayType":"SEARCH",
      "position":8
   },
   {
      "name":"search_all",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"TEXT",
      "sortType":null,
      "displayType":"EXTENDED",
      "position":1
   },
   {
      "name":"title",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"TEXT",
      "sortType":null,
      "displayType":"EXTENDED",
      "position":2
   },
   {
      "name":"description",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"TEXT",
      "sortType":null,
      "displayType":"EXTENDED",
      "position":3
   },
   {
      "name":"time",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"ENUM",
      "sortType":"ALPHA_ID",
      "displayType":"EXTENDED",
      "position":4
   },
   {
      "name":"place",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"TEXT",
      "sortType":null,
      "displayType":"EXTENDED",
      "position":5
   },
   {
      "name":"affiliate",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"TEXT",
      "sortType":null,
      "displayType":"EXTENDED",
      "position":6
   },
   {
      "name":"keywords",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"TEXT",
      "sortType":null,
      "displayType":"EXTENDED",
      "position":7
   },
   {
      "name":"language",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"ENUM",
      "sortType":"ALPHA_LABEL",
      "displayType":"EXTENDED",
      "position":8
   },
   {
      "name":"type",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"ENUM",
      "sortType":"ALPHA_LABEL",
      "displayType":"EXTENDED",
      "position":9
   },
   {
      "name":"sector",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"ENUM",
      "sortType":"ALPHA_LABEL",
      "displayType":"EXTENDED",
      "position":10
   },
   {
      "name":"provider",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"TEXT",
      "sortType":null,
      "displayType":"EXTENDED",
      "position":11
   },
   {
      "name":"category",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"ENUM",
      "sortType":null,
      "displayType":"TECHNICAL",
      "position":-1
   },
   {
      "name":"digitalisat",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"ENUM",
      "sortType":null,
      "displayType":"TECHNICAL",
      "position":-1
   },
   {
      "name":"grid_preview",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"ENUM",
      "sortType":null,
      "displayType":"TECHNICAL",
      "position":-1
   },
   {
      "name":"license",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"ENUM",
      "sortType":null,
      "displayType":"TECHNICAL",
      "position":-1
   },
   {
      "name":"state",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"ENUM",
      "sortType":null,
      "displayType":"TECHNICAL",
      "position":-1
   },
   {
      "name":"subsector",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"ENUM",
      "sortType":null,
      "displayType":"TECHNICAL",
      "position":-1
   }
]

 

Request 2

GET /search/facets?type=SEARCH HTTP/1.1
Host: api.deutsche-digitale-bibliothek.de
Accept: */*
Authorization: OAuth oauth_consumer_key="abcdefgh12345678"

Response

[
   {
      "name":"time_fct",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"ENUM",
      "sortType":"ALPHA_ID",
      "displayType":"SEARCH",
      "position":1
   },
   {
      "name":"place_fct",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"TEXT",
      "sortType":null,
      "displayType":"SEARCH",
      "position":2
   },
   {
      "name":"affiliate_fct",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"TEXT",
      "sortType":null,
      "displayType":"SEARCH",
      "position":3
   },
   {
      "name":"keywords_fct",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"TEXT",
      "sortType":null,
      "displayType":"SEARCH",
      "position":4
   },
   {
      "name":"language_fct",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"ENUM",
      "sortType":"ALPHA_LABEL",
      "displayType":"SEARCH",
      "position":5
   },
   {
      "name":"type_fct",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"ENUM",
      "sortType":"ALPHA_LABEL",
      "displayType":"SEARCH",
      "position":6
   },
   {
      "name":"sector_fct",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"ENUM",
      "sortType":"ALPHA_LABEL",
      "displayType":"SEARCH",
      "position":7
   },
   {
      "name":"provider_fct",
      "parent":null,
      "paths":[

      ],
      "role":null,
      "searchType":"ENUM",
      "sortType":null,
      "displayType":"SEARCH",
      "position":8
   }
]

Back To Top