Die prometheus-Bildarchiv-API, v1

Suchanfragen stellen, Bilder abrufen und Bildsammlungen abfragen.

Anfrage-URLs haben das folgende Format:

https://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.

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

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

Beispiele

Einträge Ihrer Datenbank auflisten (siehe GET /upload/list) (Autorisierung mit HTTP Basic authentication authorization header) :

curl --request GET -v  https://prometheus.uni-koeln.de/pandora/api/xml/upload/list --header 'Authorization: Basic YXBpOmV4YW1wbGU='

Einträge Ihrer Datenbank auflisten (siehe GET /upload/list) (Autorisierung mit OAuth authorization header):

curl --request GET -v  https://prometheus.uni-koeln.de/pandora/api/xml/upload/list --header 'Authorization: OAuth oauth_consumer_key="<oauth_consumer_key>", oauth_nonce="<oauth_nonce>", oauth_signature="<oauth_signature>", oauth_signature_method="HMAC-SHA1", oauth_timestamp="<oauth_timestamp>", oauth_token="<oauth_token>", oauth_version="1.0"'

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

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

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

    https://prometheus.uni-koeln.de/pandora/api/v1/json/search/hits?term=Baum
https://prometheus.uni-koeln.de/pandora/api/v1/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):

    https://prometheus.uni-koeln.de/pandora/api/xml/search/search?s%5B%5D=giessen_lri&term=genius
https://prometheus.uni-koeln.de/pandora/api/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):

    https://prometheus.uni-koeln.de/pandora/api/blob/image/medium/giessen_lri-eb11de4bb8e2a6c50f0440b536d040165927c47f
https://prometheus.uni-koeln.de/pandora/api/xml/image/show/giessen_lri-eb11de4bb8e2a6c50f0440b536d040165927c47f

Einen Eintrag in Deiner Datenbank erzeugen (siehe POST /upload/create):

    curl -v -u <user name>:<password> -F upload[file]=@"<file path>" -F upload[title]="<title>" -F upload[rights_reproduction|credits]="<reproduction rights or credits>" -F upload[rights_work]="<work rights>" https://prometheus.uni-koeln.de/pandora/api/xml/upload/create
  

Einen Eintrag Deiner Datenbank anzeigen (siehe GET /upload/edit):

    https://prometheus.uni-koeln.de/pandora/api/xml/upload/edit/<id>
  

Aktualisiere einen Eintrag Deiner Datenbank (siehe PUT /upload/edit):

    curl --request PUT -v -u <user name>:<password> -F id="<id>" -F upload[title]="<title>" https://prometheus.uni-koeln.de/pandora/api/xml/upload/edit
  

Einen Eintrag aus Deiner Datenbank löschen (siehe DELETE /upload/destroy):

    https://prometheus.uni-koeln.de/pandora/api/xml/upload/destroy/<id>
  

Ein Bild aus der Favoritenleiste löschen (siehe DELETE /box/delete):

    curl --request DELETE -v -u <user name>:<password> -F id="<id>" https://prometheus.uni-koeln.de/pandora/api/xml/box/delete
  

Webanwendungsbeschreibung

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

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

GET /account/show

Nutzereintrag erhalten

Anfrageparameter

id [QUERY] (erforderlich)

Id des Nutzereintrags

Typ
String

Antwortformate

json
Dateityp
application/json
xml
Dateityp
application/xml
Element
user

GET /account/terms_of_use

Aktuelle Nutzungsbedingungen erhalten

Antwortformate

json
Dateityp
application/json
xml
Dateityp
application/xml

POST /account/terms_of_use

Akzeptieren Sie die aktuellen Nutzungsbedingungen.

Anfrageparameter

accepted [QUERY] (erforderlich)

True falls akzeptiert, false anderenfalls

Typ
String

Antwortformate

json
Dateityp
application/json
xml
Dateityp
application/xml

GET /announcement/current

Liste aktueller Ankündigungen erhalten

Antwortformate

json
Dateityp
application/json
xml
Dateityp
application/xml
Element
announcements
announcement (sich wiederholend)
/announcements/announcement

POST /box/create

Ein Bild in der Favoritenleiste ablegen.

Anfrageparameter

box [QUERY] (erforderlich)

Verschachtelte Parameter welche box[id] (die ID des Objekts), box[controller] (den Controller des Objekts, nämlich image, collection oder presentation), und box[action]='show' enthalten müssen.

Typ
String

Antwortformate

json
Dateityp
application/json
xml
Dateityp
application/xml
Element
box
id
/box/id

DELETE /box/delete

Aus der Favoritenleiste entfernen.

Anfrageparameter

id [QUERY] (erforderlich)

Die id des Eintrages in der Favoritenleiste.

Typ
String

Antwortformate

json
Dateityp
application/json
xml
Dateityp
application/xml
Element
box
id
/box/id

GET /box/list

Favoriten eines Nutzers auflisten.

Antwortformate

json
Dateityp
application/json
xml
Dateityp
application/xml
Element
box
id
/box/id

POST /collection/create

Eine Bildsammlung erzeugen.

Anfrageparameter

collection [QUERY] (erforderlich)

Verschachtelter Parameter, der den Titel der Sammlung als collection[title] beinhalten muss. Bilder werden als collection[images] durch eine Liste (Array) von Bild-PIDs angegeben.

Typ
String

Antwortformate

json
Dateityp
application/json
xml
Dateityp
application/xml
Element
collection

POST /collection/delete

Sammlung löschen

Anfrageparameter

id [QUERY] (erforderlich)

Id der Bildsammlung

Typ
String

Antwortformate

json
Dateityp
application/json
xml
Dateityp
application/xml
Element
collection

GET /collection/images

Die Liste der Bilder einer Bildsammlung abrufen.

Anfrageparameter

direction [QUERY]

Richtung, in welcher die Bildsammlungen sortiert werden.

Typ
String
Optionen
ASC, DESC
Standardeinstellung
ASC
id [QUERY] (erforderlich)

Bildsammlungs-ID.

Typ
String
order [QUERY]

Attribut, nach welchem die Bildsammlungen sortiert werden.

Typ
String
Optionen
insertion_order, artist, title, location, credits
Standardeinstellung
insertion_order
page [QUERY]

Nummer der Seite, die zurückgegeben wird.

Typ
Positiveinteger
Standardeinstellung
1
per_page [QUERY]

Anzahl der Bilder, die zurückgegeben werden soll.

Typ
Positiveinteger
Standardeinstellung
30

Antwortformate

json
Dateityp
application/json
Objekt
{:id, :title, :notes, :forked_at, :owner_id, :thumbnail_id, :public_access, :meta_image, :created_at, :updated_at, :changed_at, :references, :description, :links, images: [{:pid, :artist, :title, :location, :date, :credits, :source_id, :collection_id, :votes, :image_id, :score, :checked_at}]}
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

json
Dateityp
application/json
Objekt
[{<collection fields>},...]
xml
Dateityp
application/xml
Element
collections
collection (sich wiederholend)
/collections/collection

GET /collection/meta_image_owners_fullname

Namen der Besitzer von Meta-Image Sammlungen erhalten

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

json
Dateityp
application/json
Objekt
[{"fullname":<fullname>, "id":<id>},...]
xml
Dateityp
application/xml
Element
fullnames

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/number_of_pages

Anzahl der Seiten einer Bildsammlung erhalten

Anfrageparameter

type [QUERY] (erforderlich)

Art der Bildsammlung, entweder eigene (type=own), freigegebene (type=shared), öffentliche (type=public) oder Meta-Image (type=meta_image).

Typ
String

Antwortformate

json
Dateityp
application/json
Objekt
{:number_of_pages}
xml
Dateityp
application/xml
Element
number_of_pages

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

json
Dateityp
application/json
Objekt
[{<collection fields>},...]
xml
Dateityp
application/xml
Element
collections
collection (sich wiederholend)
/collections/collection

GET /collection/own_all

Holen Sie sich die Liste aller Ihrer Sammlungen.

Antwortformate

json
Dateityp
application/json
Objekt
[{<collection fields>},...]
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

json
Dateityp
application/json
Objekt
[{<collection fields>},...]
xml
Dateityp
application/xml
Element
collections
collection (sich wiederholend)
/collections/collection

GET /collection/public_owners_fullname

Namen der Besitzer von öffentlichen Bildsammlungen erhalten

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

json
Dateityp
application/json
Objekt
[{"fullname":<fullname>, "id":<id>},...]
xml
Dateityp
application/xml
Element
fullnames

POST /collection/remove

Lösche ein Bild aus der Bildersammlung

Anfrageparameter

id [QUERY] (erforderlich)

Id der Bildsammlung

Typ
String
image [QUERY] (erforderlich)

Pid des Bildes

Typ
Array

Antwortformate

json
Dateityp
application/json
xml
Dateityp
application/xml
Element
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

json
Dateityp
application/json
Objekt
[{<collection fields>},...]
xml
Dateityp
application/xml
Element
collections
collection (sich wiederholend)
/collections/collection

GET /collection/shared_owners_fullname

Namen der Personen erhalten, die Bildsammlungen mit Ihnen geteilt haben

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

json
Dateityp
application/json
Objekt
[{"fullname":<fullname>, "id":<id>},...]
xml
Dateityp
application/xml
Element
fullnames

POST /collection/store

Speichern Sie Bilder in einer Sammlung.

Anfrageparameter

collection [QUERY] (erforderlich)

Verschachtelte Parameter, die collection[collection_id] beinhalten müssen.

Typ
String
image [QUERY] (erforderlich)

Bilder werden integriert als Array von image pids

Typ
Array

Antwortformate

json
Dateityp
application/json
xml
Dateityp
application/xml
Element
collection

GET /collection/writable

Liste aktueller schreibbarer Bildsammlungen erhalten

Antwortformate

json
Dateityp
application/json
Objekt
[{"id":<id>, "title":<title>},...]
xml
Dateityp
application/xml
Element
fullnames

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/display_fields

Anzeigefelder und deutsche Übersetzung erhalten

Antwortformate

json
Dateityp
application/json
xml
Dateityp
application/xml
Element
display_fields

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

json
Dateityp
application/json
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

json
Dateityp
application/json
Objekt
{:source_id, :score, :checked_at, :votes, :pid, <all display fields>}
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

POST /presentation/delete

Präsentation löschen

Anfrageparameter

id [QUERY] (erforderlich)

Die id der Präsentation.

Typ
String

Antwortformate

json
Dateityp
application/json
xml
Dateityp
application/xml
Element
presentation

GET /presentation/own

Die Liste Deiner Präsentationen abrufen.

Anfrageparameter

direction [QUERY]

Richtung in welche Präsentationen sortiert werden.

Typ
String
Optionen
ASC, DESC
Standardeinstellung
ASC
field [QUERY]

Suchfeld.

Typ
String
Optionen
title, description, keywords, owner, [image]
order [QUERY]

Präsentationen nach dieser Angabe sortieren

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

json
Dateityp
application/json
xml
Dateityp
application/xml
Element
presentations
presentation (sich wiederholend)
/presentations/presentation

GET /presentation/public

Die Liste öffentlichen Präsentationen abrufen.

Anfrageparameter

direction [QUERY]

Richtung in welche Präsentationen sortiert werden.

Typ
String
Optionen
ASC, DESC
Standardeinstellung
ASC
field [QUERY]

Suchfeld.

Typ
String
Optionen
title, description, keywords, owner, [image]
order [QUERY]

Präsentationen nach dieser Angabe sortieren

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

json
Dateityp
application/json
xml
Dateityp
application/xml
Element
presentations
presentation (sich wiederholend)
/presentations/presentation

GET /presentation/run

Eine Präsentation als PDF anzeigen.

Anfrageparameter

id [QUERY] (erforderlich)

Die id der Präsentation.

Typ
String

Antwortformate

pdf
Dateityp
application/pdf

GET /presentation/shared

Gibt eine Liste von Präsentationen zurück, welche mit Dir geteilt wurden.

Anfrageparameter

direction [QUERY]

Richtung in welche Präsentationen sortiert werden.

Typ
String
Optionen
ASC, DESC
Standardeinstellung
ASC
field [QUERY]

Suchfeld.

Typ
String
Optionen
title, description, keywords, owner, [image]
order [QUERY]

Präsentationen nach dieser Angabe sortieren

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

json
Dateityp
application/json
xml
Dateityp
application/xml
Element
presentations
presentation (sich wiederholend)
/presentations/presentation

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, rights_reproduction, 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, rating, comments
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
amsterdam_museum, amsterdam_rijksmuseum, amtub, arachne, archgiessen, artemis, artemis_bk, assisi, beeskow_kunstarchiv, berlin_ikb_dias, berlin_spsg, berlin_udk, berlin_winckelmann, bern, bochum_kgi, bochum_ug, bpk, caerlangen, dadaweb, darmstadt_tu, daumier, ddorf, ddorf_ka, desanhalt, digidia, digidianeu, dmr, dresden, dresden_hfbk, eichstaett_ub, erlangen_drucke, erlangen_zeichnungen, ethzuerich, genf, giessen_kup, giessen_lri, goettingen_arch, gregorsmesse, halle_kg, hamburg, heidicon_aa, heidicon_ad, heidicon_al, heidicon_ar, heidicon_bp, heidicon_fb, heidicon_fk, heidicon_gs, heidicon_ha, heidicon_ka, heidicon_kb, heidicon_kg, heidicon_pu, heidicon_sd, heidicon_sh, heidicon_si, heidicon_ua, heidicon_wa, heidicon_zo, imago, kassel, kgerlangen, kiel_digicult, koeln_rba, koeln_rba_koer, leipzig, lueneburg_oppermann, mainz, mainz_kb, marburg_lba, mka, muenster_theologie, oldenburg_afrika, paderborn, passau_dilps, piranesi, plattner_panamericana, 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

json
Dateityp
application/json
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, rights_reproduction, 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, rights_reproduction, unspecified, associated, related
Standardeinstellung
all
order [QUERY]

Feld, nach welchem die Ergebnisse sortiert werden.

Typ
String
Optionen
relevance, artist, title, location, credits, source_title, rating, comments
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

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

GET /source/list

Liste der Quelldatenbanken aerhalten

Antwortformate

json
Dateityp
application/json

POST /upload/create

Einen Eintrag in Deiner Datenbank erzeugen.

Anfrageparameter

upload [QUERY] (erforderlich)

Verschachtelter Parameter der upload[file], upload[title], upload[rights_reproduction] oder upload[credits], und upload[rights_work] beinhalten muss.

Typ
String

Antwortformate

json
Dateityp
application/json
xml
Dateityp
application/xml
Element
upload

DELETE /upload/destroy

Einen Eintrag aus Deiner Datenbank löschen.

Anfrageparameter

id [QUERY] (erforderlich)

Die id des Eintrages Deiner Datenbank.

Typ
String

Antwortformate

json
Dateityp
application/json
xml
Dateityp
application/xml
Element
upload

GET /upload/edit

Einen Eintrag Deiner Datenbank anzeigen.

Anfrageparameter

id [QUERY] (erforderlich)

Die id des Eintrages Deiner Datenbank.

Typ
String

Antwortformate

json
Dateityp
application/json
xml
Dateityp
application/xml
Element
upload

PUT /upload/edit

Aktualisiere einen Eintrag Deiner Datenbank.

Anfrageparameter

id [QUERY] (erforderlich)

Die id des Eintrages Deiner Datenbank.

Typ
String
upload [QUERY] (erforderlich)

Verschachtelte Parameter, bei denen upload[title], upload [rights_reproduction] oder upload[credits] und upload[rights_work] nicht leer sein können.

Typ
String

Antwortformate

json
Dateityp
application/json
xml
Dateityp
application/xml
Element
upload

GET /upload/list

Die Liste Deiner Datenbankeinträge abrufen.

Anfrageparameter

direction [QUERY]

Richtung in welche Datenbankeinträge sortiert werden.

Typ
String
Optionen
ASC, DESC
Standardeinstellung
ASC
field [QUERY]

Suchfeld.

Typ
String
Optionen
artist, title, location, description, keywords, inventory_no
order [QUERY]

Datenbank-Einträge nach dieser Angabe sortieren

Typ
String
Optionen
updated_at, created_at, artist, title, location
Standardeinstellung
updated_at
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
40
value [QUERY]

Suchbegriff.

Typ
String

Antwortformate

json
Dateityp
application/json
xml
Dateityp
application/xml
Element
uploads
upload (sich wiederholend)
/uploads/upload