Museum-Digital :: Handbuch

APIs für Objektinformationen

API für Einzelobjekte

Die API für einzelne Objekte gibt detaillierte Informationen zum abgerufenen Objekt zurück. Dem grundlegenden Konzept der API von museum-digital folgend, bietet sie alternative Ausgaben zur Standard-HTML-Ausgabe von Objektseiten. Abfrageparameter werden per GET-Request übergeben.

Die für das Benutzen dieser API erforderlichen Objekt-IDs können mithilfe der weiter unten beschriebenen APIs für die Suche nach Objekten in Erfahrung gebracht werden.

Basis-URLhttps://www.museum-digital.de/nat/index.php?t=objekt

Parameter

Parameter Pflicht? Default Akzeptierte Werte Beschreibung
oges Ja   Alle IDs von freigeschalteten Objekten der jeweiligen Instanz von museum-digital Objekt-ID
recordlang Nein Instanzspezifisch en, de, id, pl, ... Sprache der zurückgegebenen Objektinformationen.
Sollten Objektinformationen in der ausgewählten Sprache nicht verfügbar sein, wird in der instanzspezifischen Standardsprache zurückgegeben.
output Nein html html, json, lido Ausgabeformat der Objektinformationen

Beispiel

Frage: Welche Informationen sind in der deutschlandweiten Version von museum-digital zum Objekt mit der ID 2568 verfügbar?

Beispielabfrage $ curl "https://www.museum-digital.de/nat/index.php?t=objekt&oges=2568&output=json"

Ausprobieren

This content could unfortunately not be displayed here.


API für einfache Suche nach Objekten

Die API zur Objektsuche leitet zur entsprechenden Trefferseite weiter und gibt die Ergebnisse im ausgewählten Format zurück. Die JSON-Ausgabe gibt nur Objekt-IDs zurück. Abfrageparameter werden per GET-Request übergeben.

Basis-URLhttps://museum-digital.de/nat/search.php

Parameter

Parameter Pflicht? Default Akzeptierte Werte Beschreibung
sv Ja     Suchbegriff
startwert Nein 0 Integer-Werte im Rahmen der verfügbaren Treffer Position der Rückgabe im Rahmen der Suchergebnisse
gbreitenat Nein 24 Integer-Werte; 1-99 Anzahl der auszugebenden Treffer ab startwert (Variablenbenennung hat historische Gründe...)
output Nein html html, json Ausgabeformat der Objektinformationen

Beispiel

Frage: Welche Objekte findet die Suche zum Suchwort Helm?

Beispielabfrage $ curl "https://www.museum-digital.de/nat/search.php?sv=Helm&output=json"

Ausprobieren

This content could unfortunately not be displayed here.


API für geziehlte Suche nach Objekten

Die API zur Objektsuche gibt die entsprechende Ergebnisseite der Suche von museum-digital mit dem angegebenem Ausgabeformat zurück. Die JSON-Ausgabe gibt nur Objekt-IDs zurück. Abfrageparameter werden per GET-Request übergeben.

Basis-URLhttps://museum-digital.de/nat/index.php?t=listen

Parameter

Parameter Pflicht? Default Akzeptierte Werte Beschreibung
type Ja   s.u. Suchbegriff
startwert Nein 0 Integer-Werte im Rahmen der verfügbaren Treffer Position der Rückgabe im Rahmen der Suchergebnisse
gbreitenat Nein 24 Integer-Werte; 1-99 Anzahl der auszugebenden Treffer ab startwert (Variablenbenennung hat historische Gründe...)
suinin Nein   Integer-Werte im Rahmen der verfügbaren Institutions-IDs ID einer Institution um die Suche auf diese zu beschränken
suinsa Nein   Integer-Werte im Rahmen der verfügbaren Sammlungs-IDs ID einer Sammlung um die Suche auf diese zu beschränken
ftext Nein   1 (Volltextsuche); 2 (direkte Suche); 3 (Suche: Begriff oder Teil) Optionen zur Volltextsuche
output Nein html html, json Ausgabeformat der Objektinformationen

Die Type-Variable

Die GET-Variable type wird benötigt, um die genaue Art der Suche zu bestimmen. Soll eine gezielte Suche direkt durchgeführt werden, ist es obligatorisch, sie mitzugeben. Akzeptierte Werte sind jeweils Integer-Werte mit den in der folgenden Tabelle beschriebenen Bedeutungen. Dem gegebenen Suchtyp entsprechend, sind verschiedene spezifische Suchparameter notwendig.

Die hier häufig notwendigen IDs können über andere APIs erfragt werden (die Sammlungs-, bzw. Institutions-Such-API und die API von md:term für Personen, Zeiten, Orte und Schlagworte).

Wert der type-Variable Suchparameter Beschreibung
2 gestag [ID des gesuchten Schlagworts] Suche nach Schlagwort
3 instnr [ID der gesuchten Institution] Suche nach Objekten einer Institution
4 gesusa [ID der gesuchten Sammlung] Suche nach Objekten aus einer Sammlung
5 objektart [String-Wert] Suche nach Objekten, einer gegebenen Objektart
6 ort [ID eines verknüpften Ortes]
persinst [ID einer verknüpften Person oder Institution]
zeit [ID einer verknüpften Zeit]
Suche nach Objekten zu einer gegebenen Person / Institution, Zeit oder Ort
7 ereignistyp_id [ID eines Ereignistyps]
obz [Objektart; String-Wert]
ort_id [ID eines verknüpften Ortes]
persinst_id [ID einer verknüpften Person oder Institution]
zeit_id [ID einer verknüpften Zeit]
Suche nach Objekten, die Bedingungen kombinierter Suche erfüllen
8 gestag [ID des gesuchten Schlagworts]
ort [ID des gesuchten Ortes]
Suche nach Objekten, die Schlagwort und Ort zugeordnet sind

Beispiel 1

Frage: Welche Objekte findet die Suche zum Schlagwort mit der ID 2690 (bzw. welche Objekte sind mit dem Schlagwort Helm getaggt)?

Beispielabfrage $ curl "https://www.museum-digital.de/nat/index.php?t=listen&type=2&gestag=2690&output=json"

 Beispiel 2

Frage: Welche Objekte gehören zum Museum mit der ID 86 (99 Ergebnisse ab dem zweiten)?

Beispielabfrage $ curl "https://www.museum-digital.de/nat/index.php?t=listen&type=3&instnr=86&startwert=1&gbreitenat=99&output=json"

 

Zuletzt bearbeitet: 2017-07-29