Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Section
Column

Description

Excerpt
The 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 service and must be accessed with a HTTP-GET-request.
Code Block
languagetext
GET /items/<PathParameters>/children?<QueryParameters> HTTP/1.1
Column
width30%
Noprint
Panel
titleContent of this page

Table of Contents
maxLevel2

Request Header

NameValue(s)RequiredRepeatableDefault valueDescription
Acceptapplication/json
application/xml
*/*
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.
Noprint
Section

Back To Top

Parameters

Path

ParameterValue(s)RequiredRepeatableDefault valueDescription
identifier<item-ID>yesnoThe ID of the requested item.

 

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.

offset

<number>nonoOffset position of first entry in the result list.
rows <number>nonoNumber of entries in the result list.
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

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

Back To Top

Samples

Request 1

Code Block
languagetext
GET /items/IWOE72T2J3MNATFBPFV3PI3JQ3S3UXEL/children?oauth_consumer_key=abcdefgh12345678 HTTP/1.1
Host: api.deutsche-digitale-bibliothek.de
Accept: application/xml

Response

Noprint
Code Block
titleXML
linenumberstrue
languagexml
collapsetrue
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<hierarchy>
  <ns2:hierarchy-node xmlns:ns2="http://www.deutsche-digitale-bibliothek.de/cortex">
    <id>5FKKRMD437OERWOZXR35G22UWMUSLD3O</id>
    <parent>IWOE72T2J3MNATFBPFV3PI3JQ3S3UXEL</parent>
    <label>?Das? Schloß Du?rande</label>
    <type>htype_021</type>
    <position>100</position>
    <leaf>true</leaf>
    <isAggregationEntity>false</isAggregationEntity>
  </ns2:hierarchy-node>
  <ns2:hierarchy-node xmlns:ns2="http://www.deutsche-digitale-bibliothek.de/cortex">
    <id>OAXO2AGT7YH35YYHN3YKBXJMEI77W3FF</id>
    <parent>IWOE72T2J3MNATFBPFV3PI3JQ3S3UXEL</parent>
    <label>Egmont :ein Trauerspiel in fu?nf Aufzu?gen</label>
    <type>htype_021</type>
    <position>13</position>
    <leaf>true</leaf>
    <isAggregationEntity>false</isAggregationEntity>
  </ns2:hierarchy-node>
  <ns2:hierarchy-node xmlns:ns2="http://www.deutsche-digitale-bibliothek.de/cortex">
    <id>QCCEYVUXL3XVW5VBXH4TVT3SUUNP6KEA</id>
    <parent>IWOE72T2J3MNATFBPFV3PI3JQ3S3UXEL</parent>
    <label>Maria Stuart :ein Trauerspiel</label>
    <type>htype_021</type>
    <position>5</position>
    <leaf>true</leaf>
    <isAggregationEntity>false</isAggregationEntity>
  </ns2:hierarchy-node>
</hierarchy>

 

Request 2

Code Block
languagetext
GET /items/IWOE72T2J3MNATFBPFV3PI3JQ3S3UXEL/children HTTP/1.1
Host: api.deutsche-digitale-bibliothek.de
Accept: */*
Authorization: OAuth oauth_consumer_key="abcdefgh12345678"

Response

Noprint
Code Block
titleJSON
linenumberstrue
languagejs
collapsetrue
{
   "hierarchy":[
      {
         "id":"5FKKRMD437OERWOZXR35G22UWMUSLD3O",
         "parent":"IWOE72T2J3MNATFBPFV3PI3JQ3S3UXEL",
         "label":"?Das? Schloß Du?rande",
         "type":"htype_021",
         "position":"100",
         "leaf":true,
         "aggregationEntity":false
      },
      {
         "id":"OAXO2AGT7YH35YYHN3YKBXJMEI77W3FF",
         "parent":"IWOE72T2J3MNATFBPFV3PI3JQ3S3UXEL",
         "label":"Egmont :ein Trauerspiel in fu?nf Aufzu?gen",
         "type":"htype_021",
         "position":"13",
         "leaf":true,
         "aggregationEntity":false
      },
      {
         "id":"QCCEYVUXL3XVW5VBXH4TVT3SUUNP6KEA",
         "parent":"IWOE72T2J3MNATFBPFV3PI3JQ3S3UXEL",
         "label":"Maria Stuart :ein Trauerspiel",
         "type":"htype_021",
         "position":"5",
         "leaf":true,
         "aggregationEntity":false
      }
   ]
}  
Noprint
Section

Back To Top