DDB API

Short summery about the methods of the ddb api and what we use

All methods use an $auth_key$ this have to generate from a ddb account.

The Infomation of one Item are stored in DDBItem class.

If a resultfield or parameter is implemented than in the wiki will be add > implemented

Search Method

This method ist call with follow request

https://api.deutsche-digitale-bibliothek.de/search?oauth_consumer_key=$auth_Key$&query=$query$

For the input we get an $query$ . It's a string of the search input field The whitespace of the query are replaced by + .

Optionally we can give the following parameters.

• raws - count of max results > implemented
• offset - begin of result if the first will be skip > implemented
• sort - sorting of the results. default we use RELEVANCE > implemented

In the result of the search we get following fields

• id - item id > implemented
• type - type of creation > implemented
• category - category > implemented
• media - mediatype > implemented
• label - label of the work
• title - title > implemented
• subtitle - subtitle > implemented
• preview - for ddb
• view - for ddb
• thumbnail - url of thumbnail without domain > implemented with domain and named as imageUrl
• latitude -
• longitude -
• match - show what the $query$ match of the work