Die prometheus-Bildarchiv-API, v1

Suchanfragen stellen, Bilder abrufen und Bildsammlungen abfragen.

Anfrage-URLs haben das folgende Format:

http://prometheus.uni-koeln.de/pandora/api/v1/:format/:path

version (optional): Die API-Version (standardmäßig v1).
format (erforderlich): Eines der Antwortformate, die bei jeder Methode aufgelistet sind.
path (erforderlich): Der Pfad der Methode wie unten angegeben.

Zusätzliche Abfrageparameter können wie üblich angehängt werden. Header-Parameter müssen in den Kopfzeilen der Anfrage übermittelt werden.

Beispiele

Grundlegende Informationen über pandora als JSON und XML (siehe GET /about):

    http://prometheus.uni-koeln.de/pandora/api/v1/json/about

    http://prometheus.uni-koeln.de/pandora/api/v1/xml/about

Die Anzahl der Baum-Bilder als JSON und XML (siehe GET /search/hits):

    http://prometheus.uni-koeln.de/pandora/api/json/search/hits?term=Baum

    http://prometheus.uni-koeln.de/pandora/api/xml/search/hits?term=Baum

Die Suchergebnisse passend zu den Titeln genius und genius AND bavaria als XML (siehe GET /search/search und GET /search/advanced_search):

    http://prometheus.uni-koeln.de/pandora/api/xml/search/search?s%5B%5D=giessen_lri&term=genius

    http://prometheus.uni-koeln.de/pandora/api/v1/xml/search/advanced_search?f%5B%5D=title&o%5B%5D=and&s%5B%5D=giessen_lri&v%5B%5D=bavaria

Das Bild THE GENIUS OF BAVARIA in mittlerer Größe (siehe GET /image/medium) und seine Metadaten als XML (siehe GET /image/show):

    http://prometheus.uni-koeln.de/pandora/api/blob/image/medium/giessen_lri-eb11de4bb8e2a6c50f0440b536d040165927c47f

    http://prometheus.uni-koeln.de/pandora/api/xml/image/show/giessen_lri-eb11de4bb8e2a6c50f0440b536d040165927c47f

Webanwendungsbeschreibung

Eine maschinenlesbare Beschreibung dieser API ist verfügbar im WADL-Format:

http://prometheus.uni-koeln.de/pandora/pandora.wadl

Globale Parameter

Parameter, die für alle Methoden verfügbar sind.

`Authorization` [HEADER]

Einige API-Aufrufe erfordern eine Autorisierung. Unterstützte Verfahren sind Basic und OAuth.

`locale` [QUERY]

Typ: String
Optionen: de, en
Standardeinstellung: en

`GET /collection/images`

Die Liste der Bilder einer Bildsammlung abrufen.

Anfrageparameter

`id` [QUERY] (erforderlich)

Bildsammlungs-ID.

Typ: String

Antwortformate

`xml`

Dateityp: application/xml
Element: images
image (sich wiederholend): /images/image

`GET /collection/meta_image`

Die Liste der Meta-Image-Bildsammlungen abrufen.

Anfrageparameter

`direction` [QUERY]

Richtung, in welcher die Bildsammlungen sortiert werden.

Typ: String
Optionen: ASC, DESC
Standardeinstellung: ASC

`field` [QUERY]

Suchfeld.

Typ: String
Optionen: title, description, keywords, owner, [image]

`order` [QUERY]

Attribut, nach welchem die Bildsammlungen sortiert werden.

Typ: String
Optionen: title, changed_at, owner
Standardeinstellung: title

`page` [QUERY]

Nummer der Seite, die zurückgegeben wird.

Typ: Positiveinteger
Standardeinstellung: 1

`value` [QUERY]

Suchbegriff.

Typ: String

Antwortformate

`xml`

Dateityp: application/xml
Element: collections
collection (sich wiederholend): /collections/collection

`GET /collection/meta_image_status`

Den Meta-Image-Status einer Bildsammlung abrufen. (Eingeschränkter Zugriff)

Anfrageparameter

`id` [QUERY] (erforderlich)

Bildsammlungs-ID.

Typ: String

Antwortformate

`xml`

Dateityp: application/xml
Element: collection
id: /collection/id
meta-image: /collection/meta-image

`PUT /collection/meta_image_status`

Den Meta-Image-Status einer Bildsammlung setzen. (Eingeschränkter Zugriff)

Anfrageparameter

`id` [QUERY] (erforderlich)

Bildsammlungs-ID.

Typ: String

Antwortformate

`xml`

Dateityp: application/xml
Element: collection
id: /collection/id
meta-image: /collection/meta-image

`GET /collection/own`

Die Liste Ihrer Bildsammlungen abrufen.

Anfrageparameter

`direction` [QUERY]

Richtung, in welcher die Bildsammlungen sortiert werden.

Typ: String
Optionen: ASC, DESC
Standardeinstellung: ASC

`field` [QUERY]

Suchfeld.

Typ: String
Optionen: title, description, keywords, owner, [image]

`order` [QUERY]

Attribut, nach welchem die Bildsammlungen sortiert werden.

Typ: String
Optionen: title, changed_at, owner
Standardeinstellung: title

`page` [QUERY]

Nummer der Seite, die zurückgegeben wird.

Typ: Positiveinteger
Standardeinstellung: 1

`value` [QUERY]

Suchbegriff.

Typ: String

Antwortformate

`xml`

Dateityp: application/xml
Element: collections
collection (sich wiederholend): /collections/collection

`GET /collection/public`

Die Liste der öffentlichen Bildsammlungen abrufen.

Anfrageparameter

`direction` [QUERY]

Richtung, in welcher die Bildsammlungen sortiert werden.

Typ: String
Optionen: ASC, DESC
Standardeinstellung: ASC

`field` [QUERY]

Suchfeld.

Typ: String
Optionen: title, description, keywords, owner, [image]

`order` [QUERY]

Attribut, nach welchem die Bildsammlungen sortiert werden.

Typ: String
Optionen: title, changed_at, owner
Standardeinstellung: title

`page` [QUERY]

Nummer der Seite, die zurückgegeben wird.

Typ: Positiveinteger
Standardeinstellung: 1

`value` [QUERY]

Suchbegriff.

Typ: String

Antwortformate

`xml`

Dateityp: application/xml
Element: collections
collection (sich wiederholend): /collections/collection

`GET /collection/shared`

Die Liste der für Sie freigegebenen Bildsammlungen abrufen.

Anfrageparameter

`direction` [QUERY]

Richtung, in welcher die Bildsammlungen sortiert werden.

Typ: String
Optionen: ASC, DESC
Standardeinstellung: ASC

`field` [QUERY]

Suchfeld.

Typ: String
Optionen: title, description, keywords, owner, [image]

`order` [QUERY]

Attribut, nach welchem die Bildsammlungen sortiert werden.

Typ: String
Optionen: title, changed_at, owner
Standardeinstellung: title

`page` [QUERY]

Nummer der Seite, die zurückgegeben wird.

Typ: Positiveinteger
Standardeinstellung: 1

`value` [QUERY]

Suchbegriff.

Typ: String

Antwortformate

`xml`

Dateityp: application/xml
Element: collections
collection (sich wiederholend): /collections/collection

`POST /image/add_meta_image_comment`

Einen Meta-Image-Kommentar zu einem Bild hinzufügen. (Eingeschränkter Zugriff)

Anfrageparameter

`collection` [QUERY] (erforderlich)

Bildsammlungs-ID.

Typ: String

`f[]` [QUERY] (erforderlich)

Metadatenfeld.

Typ: String
Wiederholbar: true

`id` [QUERY] (erforderlich)

Bild-ID

Typ: String

`v[]` [QUERY] (erforderlich)

Metadatenwert.

Typ: String
Wiederholbar: true

Antwortformate

`xml`

Dateityp: application/xml
Element: image
pid: /image/pid

`GET /image/large`

Die Binärdarstellung eines Bildes in großer Größe abrufen.

Anfrageparameter

`id` [QUERY] (erforderlich)

Bild-ID

Typ: String

Antwortformate

`blob`

Dateityp: image/*

`GET /image/list`

Die Liste aller Bilder abrufen.

Anfrageparameter

`open_access` [QUERY]

Ob nur Open-Access-Bilder zurückgegeben werden.

Typ: Boolean

Antwortformate

`xml`

Dateityp: application/xml
Element: images
pid (sich wiederholend): /images/pid

`GET /image/medium`

Die Binärdarstellung eines Bildes in mittlerer Größe abrufen.

Anfrageparameter

`id` [QUERY] (erforderlich)

Bild-ID

Typ: String

Antwortformate

`blob`

Dateityp: image/*

`GET /image/show`

Die Metadaten eines Bildes abrufen.

Anfrageparameter

`id` [QUERY] (erforderlich)

Bild-ID

Typ: String

Antwortformate

`xml`

Dateityp: application/xml
Element: image
pid: /image/pid
artist: /image/artist
title: /image/title

`GET /image/small`

Die Binärdarstellung eines Bildes in kleiner Größe abrufen.

Anfrageparameter

`id` [QUERY] (erforderlich)

Bild-ID

Typ: String

Antwortformate

`blob`

Dateityp: image/*

`GET /about`

Grundlegende Informationen über pandora abrufen.

Antwortformate

`json`

Dateityp: application/json

`xml`

Dateityp: application/xml
Element: pandora
version: /pandora/version
facts: /pandora/facts

`GET /facts`

Grundlegende Zahlen und Fakten über pandora abrufen.

Antwortformate

`json`

Dateityp: application/json

`xml`

Dateityp: application/xml
Element: pandora
images: /pandora/images
sources: /pandora/sources
licenses: /pandora/licenses
accounts: /pandora/accounts
version: /pandora/version

`GET /search/advanced_search`

Eine "erweiterte" Suche durchführen.

Anfrageparameter

`f[]` [QUERY] (erforderlich)

Suchfeld.

Typ: String
Optionen: all, artist, title, location, discoveryplace, genre, material, keyword, description, date, credits, unspecified, associated, related
Wiederholbar: true

`o[]` [QUERY]

Suchoperator.

Typ: String
Optionen: and, or, and not
Wiederholbar: true

`order` [QUERY]

Feld, nach welchem die Ergebnisse sortiert werden.

Typ: String
Optionen: relevance, artist, title, location, credits, source_title
Standardeinstellung: relevance

`page` [QUERY]

Nummer der Seite, die zurückgegeben wird.

Typ: Positiveinteger
Standardeinstellung: 1

`per_page` [QUERY]

Anzahl der Treffer, die pro Seite angezeigt werden.

Typ: Positiveinteger
Standardeinstellung: 10

`s[]` [QUERY]

Quellen, die durchsucht werden.

Typ: String
Optionen: amtub, arachne, archgiessen, artemis, artemis_bk, assisi, beeskow_kunstarchiv, berlin_spsg, berlin_udk, berlin_winckelmann, bern, bochum_kgi, bochum_ug, bpk, caerlangen, dadaweb, daumier, ddorf, desanhalt, digidia, digidianeu, dmr, dresden, erlangen_drucke, erlangen_zeichnungen, ethzuerich, genf, giessen_kup, giessen_lri, goettingen_arch, gregorsmesse, hamburg, heidicon_aa, heidicon_ad, heidicon_bp, heidicon_fb, heidicon_fk, heidicon_gs, heidicon_ha, heidicon_ka, heidicon_kb, heidicon_kg, heidicon_sh, heidicon_si, heidicon_wa, heidicon_zo, imago, kassel, kgerlangen, kiel_digicult, leipzig, lueneburg_oppermann, mainz, mainz_kb, marburg_lba, mka, paderborn, piranesi, ppo, requiem, robertin, saarbruecken_ifk, salzburg, stabi, theoleik, trier, tuberlin, uustb, virtualart, wbarchiv, zi_muc
Wiederholbar: true

`v[]` [QUERY] (erforderlich)

Suchbegriff.

Typ: String
Wiederholbar: true

Antwortformate

`xml`

Dateityp: application/xml
Element: search
results/result (sich wiederholend): /search/results/result
query: /search/query
count: /search/count

`GET /search/hits`

Anzahl der Treffer, die eine "einfache" Suche liefern würde.

Anfrageparameter

`field` [QUERY]

Suchfeld.

Typ: String
Optionen: all, artist, title, location, discoveryplace, genre, material, keyword, description, date, credits, unspecified, associated, related
Standardeinstellung: all

`term` [QUERY] (erforderlich)

Suchbegriff.

Typ: String

Antwortformate

`json`

Dateityp: application/json

`xml`

Dateityp: application/xml
Element: hits
query: /hits/query
count: /hits/count

`GET /search/search`

Eine "einfache" Suche durchführen.

Anfrageparameter

`field` [QUERY]

Suchfeld.

Typ: String
Optionen: all, artist, title, location, discoveryplace, genre, material, keyword, description, date, credits, unspecified, associated, related
Standardeinstellung: all

`order` [QUERY]

Feld, nach welchem die Ergebnisse sortiert werden.

Typ: String
Optionen: relevance, artist, title, location, credits, source_title
Standardeinstellung: relevance

`page` [QUERY]

Nummer der Seite, die zurückgegeben wird.

Typ: Positiveinteger
Standardeinstellung: 1

`per_page` [QUERY]

Anzahl der Treffer, die pro Seite angezeigt werden.

Typ: Positiveinteger
Standardeinstellung: 10

`term` [QUERY] (erforderlich)

Suchbegriff.

Typ: String

Antwortformate

`xml`

Dateityp: application/xml
Element: search
results/result (sich wiederholend): /search/results/result
query: /search/query
count: /search/count