Description
The methodchildren 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.Request Header
| Name | Value(s) | Required | Repeatable | Default value | Description |
|---|---|---|---|---|---|
Accept | application/jsonapplication/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. |
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. |
| <number> | no | no | – | Offset position of first entry in the result list. |
rows | <number> | no | no | – | Number of entries in the result list. |
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
| Code | Text | Description |
|---|---|---|
403 | Forbidden | Item is not available via API (items can be blacklisted because of copyright issues) |
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. |
Samples
Request 1
Response