Skip to end of metadata
Go to start of metadata

Description

The method binary 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.
Content of this page

Request Header

NameValue(s)RequiredRepeatableDefault valueDescription
Acceptapplication/octet-stream
*/*
yesnoapplication/octet-streamSpecifies the format of the accepted data. In any case application/octet-stream will be delivered.
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.

Parameters

Path

ParameterValue(s)RequiredRepeatableDefault valueDescription
identifier<item-ID>yesnoThe ID of the requested item.
binaryPathFile<path/filename>yesnoThe relative path and the filename of a binary file separated by slashes.
The path and filename can be retrieved via the method binaries.

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.

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

CodeTextDescription
403
Forbidden 
Item is not available via API (items can be blacklisted because of copyright issues)
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.

Samples

Request

Response

 

Request

Response

  • No labels