Section

Column

Description

Excerpt
The 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.

Code Block

language	text

GET /items/<PathParameters>/indexing-profile?<QueryParameters> HTTP/1.1

Column

width	30%

Noprint

Panel

title	Content of this page

Table of Contents

maxLevel	2

Request Header

Name	Value(s)	Required	Repeatable	Default value	Description
`Accept`	`application/json` `application/xml` `/`	yes	no	`application/json`	Specifies 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.
`Authorization`	`OAuth oauth_consumer_key="<API key>"`	yes	no	–	An 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.
`Host`	`api.deutsche-digitale-bibliothek.de`	yes	no	–	The host is mandatory.

Noprint

Section
Back To Top

Parameters

Path

Parameter	Value(s)	Required	Repeatable	Default value	Description
`identifier`	`<item-ID>`	yes	no	–	The ID of the requested item.

Query

Parameter	Value(s)	Required	Repeatable	Default value	Description
`oauth_consumer_key`	`<API key>`	yes	no	–	An 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.

Noprint

Section
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.

Noprint

Section
Back To Top

Errors

Code	Text	Description
`404`	`Not Found`	Either the item does not exist or has no data.
`406`	`Not Acceptable`	The Request Header is not acceptable. Please see section Request Header.
`500`	`Server Error`	Something went terribly wrong. An error message will provide a meaningful description.

Noprint

Section
Back To Top

Samples

Request 1

Code Block

language	text

GET /items/OAXO2AGT7YH35YYHN3YKBXJMEI77W3FF/indexing-profile?oauth_consumer_key=abcdefgh12345678 HTTP/1.1
Host: api.deutsche-digitale-bibliothek.de
Accept: application/xml

Response

Noprint

Code Block

title	XML
linenumbers	true
language	xml
collapse	true

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<indexing-profile xmlns="http://www.deutsche-digitale-bibliothek.de/cortex">
  <item-id>OAXO2AGT7YH35YYHN3YKBXJMEI77W3FF</item-id>
  <facet name="time_fct">
    <value>time_62000</value>
    <value>time_62050</value>
  </facet>
  <facet name="place_fct">
    <value>Paderborn</value>
  </facet>
  <facet name="affiliate_fct">
    <value>Scho?ningh</value>
    <value>Goethe, Johann Wolfgang ?von? (1749-1832)</value>
  </facet>
  <facet name="affiliate_fct_role">
    <value>Scho?ningh</value>
    <value>Goethe, Johann Wolfgang ?von? (1749-1832)</value>
    <value>Scho?ningh_1_affiliate_fct_involved</value>
    <value>Goethe, Johann Wolfgang ?von? (1749-1832)_1_affiliate_fct_involved</value>
  </facet>
  <facet name="affiliate_fct_normdata">
    <value>http://d-nb.info/gnd/118540238</value>
  </facet>
  <facet name="affiliate_fct_role_normdata">
    <value>http://d-nb.info/gnd/118540238</value>
    <value>http://d-nb.info/gnd/118540238_1_affiliate_fct_involved</value>
  </facet>
  <facet name="keywords_fct">
    <value>Monografie</value>
    <value>Deutsche Literatur</value>
    <value>Belletristik</value>
  </facet>
  <facet name="keywords_fct_normdata">
    <value>http://d-nb.info/ddc-sg/830</value>
    <value>http://d-nb.info/ddc-sg/B</value>
  </facet>
  <facet name="language_fct">
    <value>ger</value>
  </facet>
  <facet name="type_fct">
    <value>mediatype_003</value>
  </facet>
  <facet name="sector_fct">
    <value>sec_02</value>
  </facet>
  <facet name="provider_fct_normdata">
    <value>http://ld.zdb-services.de/data/organisations/DE-101</value>
  </facet>
  <facet name="provider_fct">
    <value>Deutsche Nationalbibliothek</value>
  </facet>
  <facet name="last_update">
    <value>14-03-13 18:42:51</value>
  </facet>
</indexing-profile>

Request 2

Code Block

language	text

GET /items/OAXO2AGT7YH35YYHN3YKBXJMEI77W3FF/indexing-profile HTTP/1.1
Host: api.deutsche-digitale-bibliothek.de
Accept: */*
Authorization: OAuth oauth_consumer_key="abcdefgh12345678"

Response

Noprint

Code Block

title	JSON
linenumbers	true
language	js
collapse	true

{
   "item-id":"OAXO2AGT7YH35YYHN3YKBXJMEI77W3FF",
   "facet":[
      {
         "@name":"time_fct",
         "value":[
            "time_62000",
            "time_62050"
         ]
      },
      {
         "@name":"place_fct",
         "value":"Paderborn"
      },
      {
         "@name":"affiliate_fct",
         "value":[
            "Scho?ningh",
            "Goethe, Johann Wolfgang ?von? (1749-1832)"
         ]
      },
      {
         "@name":"affiliate_fct_role",
         "value":[
            "Scho?ningh",
            "Goethe, Johann Wolfgang ?von? (1749-1832)",
            "Scho?ningh_1_affiliate_fct_involved",
            "Goethe, Johann Wolfgang ?von? (1749-1832)_1_affiliate_fct_involved"
         ]
      },
      {
         "@name":"affiliate_fct_normdata",
         "value":"http://d-nb.info/gnd/118540238"
      },
      {
         "@name":"affiliate_fct_role_normdata",
         "value":[
            "http://d-nb.info/gnd/118540238",
            "http://d-nb.info/gnd/118540238_1_affiliate_fct_involved"
         ]
      },
      {
         "@name":"keywords_fct",
         "value":[
            "Monografie",
            "Deutsche Literatur",
            "Belletristik"
         ]
      },
      {
         "@name":"keywords_fct_normdata",
         "value":[
            "http://d-nb.info/ddc-sg/830",
            "http://d-nb.info/ddc-sg/B"
         ]
      },
      {
         "@name":"language_fct",
         "value":"ger"
      },
      {
         "@name":"type_fct",
         "value":"mediatype_003"
      },
      {
         "@name":"sector_fct",
         "value":"sec_02"
      },
      {
         "@name":"provider_fct_normdata",
         "value":"http://ld.zdb-services.de/data/organisations/DE-101"
      },
      {
         "@name":"provider_fct",
         "value":"Deutsche Nationalbibliothek"
      },
      {
         "@name":"last_update",
         "value":"14-03-13 18:42:51"
      }
   ]
}

Noprint

Section
Back To Top

Versions Compared

Old Version 1

New Version 2

Key

Description

Request Header

Parameters

Path

Query

Authorization

Errors

Samples

Request 1

Response

Request 2

Response

Page History

Versions Compared

Old Version 1

New Version 2

Key

Description

Request Header

Parameters

Path

Query

Authorization

Errors

Samples

Request 1

Response

Request 2

Response