Description
The methodbinary returns the content of a binary file of an item for a given item-ID. This method provides response data as application/octet-stream. A binary file at DDB can be a picture, a tumbnail of a picture, a video clip, an audio file etc. 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/octet-stream*/* | yes | no | | Specifies the format of the accepted data. In any case application/octet-stream will be delivered. |
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. |
binaryPathFile | <path/filename> | yes | no | – | The relative path and the filename of a binary file separated by slashes. The path and filename can be retrieved via the method binaries. |
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. |
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
Response
Request
Response