Die RVK-API - Regensburger Verbundklassifikation Online

Link zur aktuellen RVK-Schnittstelle: https://rvk.ur.de/api3/json/

Link zur vorherigen RVK-Schnittstelle: Kurzdoku der Vorgänger-API

1. Was ist die RVK-API?

Die Universitätsbibliothek Regensburg stellt eine Programmierschnittstelle (API) für die Regensburger Verbundklassifikation (RVK) bereit. Die API ermöglicht den maschinellen Zugriff auf das Datenbanksystem RVK-Online und unterstützt die Nutzung der RVK in eigenen Anwendungen. Durch die Schnittstelle können RVK-Daten automatisiert abgefragt, verarbeitet und in eigene Systeme integriert werden.

Die RVK ist hierarchisch aufgebaut. Jede RVK-Notation kann übergeordnete und untergeordnete Notationen besitzen. Die API ermöglicht sowohl den Zugriff auf einzelne Notationen als auch auf deren Einordnung innerhalb der Hierarchie.

2. Welche Funktionen unterstützt die RVK API?

Je nach Anwendungsfall stehen unterschiedliche API-Funktionen zur Verfügung. Die wichtigsten Funktionen sind:

Anzeige der RVK-Hierarchie:
Der Baum der RVK kann über die Funktionen nodeNt, nodeId, children und ancestors abgebildet werden.
Suche in der RVK:
Die Funktion nodes ermöglicht die Suche nach einem Wortbestandteil in Benennung und Register.
Register:
Die Funktion register ermöglicht das Suchen und Blättern im Register.
Historische Informationen:
Die Funktion history ermöglicht den Zugriff auf historische Änderungen von RVK-Notationen.

3. Erste Schritte & Ausgabeformat

Die API kann direkt im Browser oder mit einem HTTP-Client aufgerufen werden. Die Antwort erfolgt im JSON-Format.

Zum Einstieg eignet sich beispielsweise folgende Abfrage:

https://rvk.ur.de/api3/json/notation/nodeNt/ST%20180

Sie liefert die Informationen zur RVK-Notation ST 180 einschließlich Benennung, RVK-ID und weitere Metadaten.

{
  "node": {
    "id": "143605:",
    "notation": "ST 180",
    "benennung": "Peripheriegeräte",
    "has_children": "no"
  }
}

4. Welche Informationen werden ausgegeben?

Die Struktur der JSON-Ausgabe hängt von der verwendeten API-Funktion ab. Die folgenden Felder werden in mehreren Antworttypen verwendet. Zusätzliche Felder einzelner Funktionen sind bei den jeweiligen API-Funktionen beschrieben.

Container/Strukturelemente:

JSON-Element	Bedeutung
node	Enthält eine oder mehrere RVK-Notationen
children	Enthält die direkt untergeordneten RVK-Notationen einer Hierarchieebene
ancestors	Enthält die übergeordneten RVK-Notationen bis zur Wurzelebene
register	Enthält Registereinträge zu einer RVK-Notation.

Felder einer RVK-Notation:

Feld	Feldbeschreibung
id	Eindeutige Kennung der RVK-Notation (RVK-ID)
notation	RVK-Notation
benennung	Bezeichnung der RVK-Notation
lang / language	Sprache der Bezeichnung der RVK-Notation (z. B. de)
has_children	Gibt an, ob untergeordnete RVK-Notationen vorhanden sind (yes/no)
bemerkung	Zusätzliche Hinweise oder Erläuterungen zur RVK-Notation
verweis	Verweise auf verwandte oder alternative Notationen
register	Zugeordnete Registereinträge der RVK-Notation

Felder eines Registereintrags:

Feld	Feldbeschreibung
begriff	Schlagwort bzw. Registerbegriff
gndnr	GND-Identifikationsnummer des Registerbegriffs
pv	Kennzeichnung der Art des Registereintrags, z. B. bevorzugter Begriff oder Verweisform (p/v)

Zusätzliche Felder historischer Informationen:

Feld	Feldbeschreibung
new	Version, in der eine RVK-Notation neu aufgenommen wurde
upd	Version, in der eine RVK-Notation geändert wurde
del	Version, in der eine RVK-Notation gelöscht wurde

5. API-Funktionen und Beispielabfragen

Anzeige der RVK-Hierarchie:

Funktion	Beschreibung	Beispiel
children	Gibt die direkt untergeordneten Notationen einer Hierarchieebene aus	https://rvk.ur.de/api3/json/notation/children https://rvk.ur.de/api3/json/notation/children/17601: https://rvk.ur.de/api3/json/notation/children/142532:12576
nodeNt	Gibt eine RVK-Notation anhand ihrer Notationsbezeichnung aus	https://rvk.ur.de/api3/json/notation/nodeNt/ST https://rvk.ur.de/api3/json/notation/nodeNt/ST 180
nodeId	Gibt eine RVK-Notation anhand ihrer eindeutigen ID aus	https://rvk.ur.de/api3/json/notation/nodeId/128995:
ancestors	Gibt die übergeordneten Hierarchieebenen einer Notation aus	https://rvk.ur.de/api3/json/notation/ancestors/103111: https://rvk.ur.de/api3/json/notation/ancestors/142532:12576

Suche in der RVK:

Funktion	Beschreibung	Beispiel
nodes	Sucht nach Begriffen in Benennungen und Registereinträgen	https://rvk.ur.de/api3/json/notation/nodes/Rotalgen

Register:

Funktion	Beschreibung	Beispiel
listPN	Sucht Registerbegriffe	https://rvk.ur.de/api3/json/register/listPN?regName=Rotalgen
listPNVN	Sucht Registerbegriffe inklusive Verweisformen	https://rvk.ur.de/api3/json/register/listPNVN?regName=Rotalgen
PNinNt	Ermittelt RVK-Notationen zu Registerbegriffen	https://rvk.ur.de/api3/json/register/PNinNt?regName[]=Zahlensystem https://rvk.ur.de/api3/json/register/PNinNt?regName[]=Zahlensystem&regName[]=Beweistheorie
withVNinNt	Ermittelt RVK-Notationen inklusive Verweisformen zu Registerbegriffen	https://rvk.ur.de/api3/json/register/withVNinNt?regName[]=Zahlensystem
withPNVNinNt	Ermittelt RVK-Notationen mit bevorzugten Begriffen und Verweisformen	https://rvk.ur.de/api3/json/register/withPNVNinNt?regName[]=Zahlensystem

Historische Informationen:

Funktion	Beschreibung	Beispiel
history	Gibt historische Informationen zu einer RVK-Notation aus	https://rvk.ur.de/api3/json/notation/history/NQ 8316

6. An wen kann ich mich wenden, wenn ich Anmerkungen habe oder Fehler auftreten?

Bei technischen Fragen: technik.rvk@ur.de

7. Hinweise zur Datennutzung

Die Schnittstelle ist frei verfügbar und kostenfrei, die Daten dürfen unter der Lizenz CC0 1.0 nachgenutzt werden.