DBIS-XML-Ausgabe
Link zur Schnittstelle sowie zur Schnittstellenbeschreibung (interaktive Swagger-Dokumentation): https://dbis-api.ur.de
1. Wozu dient das XML-Ausgabeformat von DBIS?
Mithilfe der XML-Ausgabe können DBIS-Angebote auf den Websites der DBIS-Anwendereinrichtungen oder in Rechercheportalen im eigenen Layout integriert werden.
Die XML-Schnittstelle wurde für die neue DBIS-Version (Release 10/2024) angepasst. Alle Endpunkte, die ihre Daten als XML zurückgeben, wurden erstellt, um so viel Abwärtskompatibilität wie möglich mit dem alten DBIS-System zu gewährleisten.
Tipp: Sollten Sie vor der Wahl stehen, ob Sie die DBIS-XML-Ausgabe oder DBIS-JSON-Rest-API verwenden, empfehlen wir bevorzugt mit der DBIS-JSON-Rest-API zur arbeiten.
Die neuen IDs für die alten Fachgebiete finden Sie hier: https://dbis.ur.de/services
2. Übergabeparameter
Folgende Parameter können der Schnittstelle übergeben werden:
Übergabeparameter | Werte | Standartwert (Default) | Erläuterung |
lang | ‚de‘ oder ‚en‘ | ‚de‘ | Wählen Sie die Sprache der zurückgegebenen Daten aus. |
bib_id | / | / | Die eindeutige Kennung einer teilnehmenden Organisation, auch bekannt als URL-BIBID. Sie wird im Admin-Bereich angezeigt. |
titel_id | / | Ressourcen-ID des Datensatzes, der zurückgegeben werden soll | |
xmloutput | / | true | Muss auf 1 / true gesetzt werden. |
include[] | licenses, description | list [licenses] | Flags zum Hinzufügen weiterer Informationen zum Ergebnis. |
Suchwort | / | / | Wird für die Textsuche verwendet. |
gebiete | / | / | Wenn Sie die Ressourcen eines Fachgebiets abfragen möchten, geben Sie hier die subject_id oder die collection_id ein. |
all | / | / | Wenn auf „true“ gesetzt, werden nicht lizenzierte Ressourcen einbezogen. |
lett | / | / | Ein einzelner Buchstabe, der angibt, ob ein Fachgebiet (f) oder eine Sammlung (c) gewünscht wird. Alternativ wird eine alphabetische Sortierung (a) angefordert. |
offset | / | / | Für die Paginierung. Paginierung und sort=type schließen sich gegenseitig aus. |
hits_per_page | / | / | Für die Paginierung. Paginierung und sort=type schließen sich gegenseitig aus. |
sort | / | / | Mit „sort=alph“ werden die Ergebnisse alphabetisch sortiert. Bei der neuen DBIS-Version ist dies überflüssig, da die Ergebnisse ohnehin alphabetisch sortiert sind. Alternativ können Sie „sort=type“ angeben, um die Ergebnisse nach Typ zu gruppieren, anstatt sie alphabetisch zu sortieren. Paginierung und „sort=type“ schließen sich gegenseitig aus. |
db_type | / | / | Filter für einen oder mehrere Ressourcentypen (dieser Parameter kann mehrfach hinzugefügt werden). Das Suchergebnis enthält nur Ressourcen mit den angegebenen db_type_id(s) |
colors | / | / | Lizenz-, Zugangs-, -typ, -form |
3. Statusnachrichten
Die folgende Tabelle bietet eine Übersicht der möglichen Statusmeldungen, die von der Schnittstelle ausgegeben werden können.
Status-Code | Statusnachricht (DE) | Statusnachricht (EN) |
200 | Gibt die angeforderten Daten zurück. | Returns requested data |
403 | Wird zurückgegeben, wenn die angeforderten Daten auf „unsichtbar“ gesetzt sind. | Returned when the requested data is set to invisible |
404 | Wird zurückgegeben, wenn entweder die Ressource oder die Institution nicht gefunden wurde. | Is returned when either the resource or the institution was not found. |
4. Endpunkte der DBIS-XML
4.1 /detail.php
Abruf aller Details zu einer Ressource. Entweder global oder für eine Organisation.
Bitte beachten Sie, dass einige der XML-Knoten im Ergebnis als veraltet gelten, da sie nicht mehr der internen Datenstruktur des neuen DBIS entsprechen.
Die veralteten Knoten sind: db_access_info, accesses, publisher.
Bitte entnehmen Sie die Informationen stattdessen dem neuen Knoten „licenses“.
Ausgabefeld | Beschreibung |
<?xml version=“1.0″ encoding=“UTF-8″?> |
|
<dbis_page xsi:noNamespaceSchemaLocation=“https://dbis.ur.de/dbinfo/scheme/dbis_page_output.xsd“ version=“1.0.0″ xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“> | Anfang Ausgabe der Daten dieses Endpunktes |
<library bib_id> | URL-BIBID |
<page_vars> | Anfang |
<bib_id> | Alte DBIS-BIBID |
<titel_id> | Ressourcen-ID |
</page_vars> | Ende |
<headline> | Ansicht (Detailansicht) |
<details> | Details der Datenbank folgend |
<titles> | Anfang Titelinformationen |
<title main=“Y“> | Offizieller Titel |
<title main=“N“> | Alternativer Titel |
</titles> | Ende der Titelinformationen |
<db_access_info access_id=“____“ traffic_light=“____“> | Zugang Ampelfarbe |
<db_access> | Zugangsbeschriftung |
<db_access_short_text> | Zugangsbeschriftung Nutzung |
</db_access_info> | Ende Zugangsinformationen |
<accesses> | Zugänge |
<access main=“Y/N“ type=“_“ href=“Link“/> | Hauptzugang (yes / no) Zugangstyp Zugangslink |
</accesses> | Ende Zugangsinformationen |
<hints> | Externe Bemerkungen |
</hints> | Ende externe Bemerkungen |
<content> | Beschreibung |
</content> | Ende Beschreibung |
<content_eng> | Beschreibung englisch |
</content_eng> | Ende Beschreibung englisch |
<instruction> </instruction> | Anleitung |
<instruction_eng> </instruction_eng> | Anleitung englisch |
<licenses traffic_light=“_“> | Ampelfarbe (green / yellow / red) |
<license id=“_“ type_id=“_“ form_id=“_“ publication_form_title=“_“ external_notes=“_“> | ID der Lizenz ID des Lizenztyps ID der Lizenzform Titel des Formaltyps Externe Bermerkungen |
<access id=“_“ license_id=“_“ type_id=“_“ main=“_“ access_url=“Link“ label=“_“ long_label=“_“ longest_label=“_“ description=“_“ requirements=“_“/>
| ID des Zugangs ID der Lizenz ID des Zugangstyps Hauptzugang (true / false) Zugangsbeschriftung Zugangsbeschriftung Nutzung Zugangsbeschriftung Nutzung lange Erklärung Beschreibung Anforderungen |
</license> | Ende Lizenzinformationen |
</licenses> | Ende Lizenzinformationen |
<subjects> | Anfang Fachgebietsinformationen |
<subject collection=“_“>_</subject>
| Fachgebiet ist gleichzeitig Sammlung (true / false) Titel des Fachgebiets Ende Fachgebietinformationen |
</subjects> | Ende Fachgebietinformationen |
<keywords> | Anfang Schlagwortinformationen |
<keyword>_</keyword> | Schlagwort |
</keywords> | Ende Schlagwortinformationen |
<appearence>_</appearence> | Formaltyp |
<db_type_infos> | Anfang Datenbanktypinformationen |
<db_type_info db_type_id=“_“>
| ID des Datenbanktyp |
<db_type>_</db_type> | Titel Datenbanktyp |
<db_type_long_text>_</db_type_long_text> | Beschreibung Datenbanktyp |
</db_type_info> | Ende Datenbanktypinformationen |
<publisher>_<publisher> | Verlag |
</details> | Ende Details der Datenbank |
</dbis_page> | Ende der ausgelieferten Daten dieses Endpunktes |
4.2 /fachliste.php
Abruf einer Liste aller Fachgebiete. Wenn eine Organisation angegeben ist, sind auch lokal definierte Fachgebiete und Sammlungen (sofern als Thema gekennzeichnet) enthalten.
Ausgabefeld | Beschreibung |
<?xml version=“1.0″ encoding=“UTF-8″?> |
|
<dbis_page xsi:noNamespaceSchemaLocation=“https://dbis.ur.de/dbinfo/scheme/dbis_page_output.xsd“ version=“1.0.0″ xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“> | Anfang Ausgabe der Daten dieses Endpunktes |
<library bib_id> | URL-BIBID |
<page_vars> | Anfang |
<bib_id> | Alte DBIS-BIBID |
</page_vars> | Ende |
<headline> | Ansicht (Detailansicht) |
<list_subjects_collections> | Anfang Informationen über Fachgebiete und Sammlungen |
<list_subjects_collections_item lett=“_“ notation=“_“ number=“_“ subject_id=“_“>_</list_subjects_collections_item> <list_subjects_collections_item lett=“_“ notation=“_“ number=“_“ collection_id=“_“>_</list_subjects_collections_item>
| Item_lett (f = Fachgebiet; c = Sammlung) Notation = Notation des Fachgebietstitels Number = Anzahl der Datenbank, die Teil des Fachgebiets bzw. der Sammlung sind Subject_id = ID des Fachgebiets Collection_id = ID der Sammlung
|
</list_subjects_collections> | Ende Informationen über Fachgebiete und Sammlungen |
</dbis_page> | Ende der ausgelieferten Daten dieses Endpunktes |
4.3 /dbliste.php
Dies ist eine Suchfunktion, die eine Liste von Ressourceneinträgen zurückgibt. Es sind verschiedene Kombinationen von Parametern möglich:
- Auflistung aller Ressourcen, entweder global oder aus der Perspektive einer Organisation. Dieser Suchmodus wird ausgelöst, wenn keiner der anderen Modi verwendet wird. In diesem Modus wird die Verwendung der Paginierung empfohlen.
- Auflistung der Ressourcen eines Fachgebiets oder einer Sammlung: Verwenden Sie lett=f und gebiete oder lett=c und collid.
- Suche nach Ressourcen nach Typ: Verwenden Sie db_type mit einer entsprechenden type_id (oder geben Sie sort=type in Kombination mit einem der vorherigen Modi an, um ein ähnliches Ergebnis zu erhalten).
- Freitextsuche (einfach): Verwenden Sie Suchwort, um Ihren Suchtext einzugeben.
- Freitextsuche (komplex): Die Parameter jq_termN, jq_typeN usw. ermöglichen komplexere Suchanfragen. Diese Funktionalität wurde im neuen System nur teilweise nachgebildet.
Ausgabefeld | Beschreibung |
<?xml version=“1.0″ encoding=“UTF-8″?> |
|
<dbis_page xsi:noNamespaceSchemaLocation=“https://dbis.ur.de/dbinfo/scheme/dbis_page_output.xsd“ version=“1.0.0″ xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“> | Anfang Ausgabe der Daten dieses Endpunktes |
<library bib_id> | URL-BIBID |
<page_vars> | Anfang |
<bib_id> | Alte DBIS-BIBID |
<gebiete>35</gebiete>
| ID des Fachgebiets bzw. der Sammlung |
<include>licenses</include> | Inklusive Lizenzen |
<Suchwort>“_“</Suchwort>
| Gesuchter Datenbanktitel |
<sort>alph</sort>
| Alphabetische Sortierung |
</page_vars>
| Ende |
<headline>_</headline>
| Fachgebiet |
<search_desc>
| Alternativer Titel |
<search_desc_item>Suche über alle Felder: „_“</search_desc_item>
| Sucheingabe |
</search_desc>
| Ende Sucheingabe |
<list_dbs>
| Anfang Liste der Details der Datenbank |
<db_type_infos>
| Anfang Informationen Datenbanktyp |
<db_type_info db_type_id=“db_type__“>
| ID des Datenbanktyps |
<db_type>_</db_type>
| Titel des Datenbanktyps |
<db_type_long_text>_</db_type_long_text>
| Beschreibung Datenbanktyp |
</db_type_info>
| Ende Informationen Datenbanktyp |
<dbs sort=“_“ top_db=“_“ db_count=“_“>
| dbs sort = Sortierung (alph / rel) top_db = ID Top-Datenbank db_count = ? |
<db title_id=“_“ db_type_refs=“_“ top_db=“_“>
| db title_id = ID des Titels db_type_refs = top_db = ID Top-Datenbank |
<licenses traffic_light=“_“>
| Ampelfarbe (green / yellow / red) |
<license id=“_“ type_id=“_“ form_id=“_“>
| license id = ID der Lizenz type_id = ID des lizenztyps form_id = ID der Lizenzform |
<access id=“_“ form_id=“_“ type_id=“_“ access_url=“URL“/>
| access id = ID des Zugangs form_id = ID der Zugangsform type_id = ID des Zugangstyps access_url = Zugangslink |
</license> </licenses>
| Ende Lizenzinformationen |
</db>
| Ende |
</dbs>
| Ende |
</list_dbs>
| Ende der Informationen zur Datenbank |
</dbis_page>
| Ende der ausgegebenen Informationen |
4.4 /suche.php
Abruf verschiedener statischer Informationen, die für andere Endpunkte nützlich sein können.
Ausgabefeld | Beschreibung |
<?xml version=“1.0″ encoding=“UTF-8″?> |
|
<dbis_page xsi:noNamespaceSchemaLocation=“https://dbis.ur.de/dbinfo/scheme/dbis_page_output.xsd“ version=“1.0.0″ xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“> | Anfang Ausgabe der Daten dieses Endpunktes |
<library bib_id> | URL-BIBID |
<page_vars> | Anfang |
<bib_id> | Alte DBIS-BIBID |
</page_vars>
| Ende |
<headline>Suche nach Datenbanken (Erweiterte Suche)</headline> | Suche |
<dbis_search>
| Anfang Suche |
<option_list name=“jq_type“>
| Suchoptionen |
<option value=“AL“>Suche über alle Felder</option>
| Suche über alle Felder |
<option value=“KT“>Titelwort(e)</option>
| Titelwort(e) |
<option value=“CO“>Beschreibung</option>
| Beschreibung |
<option value=“KW“>Schlagwort</option>
| Schlagwort |
<option value=“KS“>Titelanfang</option>
| Titelanfang |
<option value=“PU“>Verlag</option>
| Verlag |
<option value=“LD“>Eingabedatum</option>
| Eingabedatum |
</option_list>
| Ende Suchoptionen |
<option_list name=“jq_bool“>
| Boolesche Operatoren |
<option value=“AND“>und</option>
| „und“ |
<option value=“OR“>oder</option>
| „oder“ |
</option_list>
| Ende Boolesche Operatoren |
<option_list name=“jq_not“>
| Boolesche Operatoren |
<option value=“1″/>
| positiv |
<option value=“NOT“>nicht</option>
| negativ |
</option_list>
| Ende |
<option_list name=“gebiete“>
| Anfang Informationen Fachgebiete |
<option value=“_“>_</option>
| ID und Titel des Fachgebiets |
</option_list>
| Ende Informationen Fachgebiete |
<option_list name=“db_types“>
| Anfang Informationen Datenbanktypen |
<option value=“_“>_</option>
| ID und Titel des Datenbanktyps |
</option_list>
| Ende Informationen Datenbanktyp |
<option_list name=“zugaenge“>
| Anfang Informationen Zugang |
<option value=“1000″/>
|
|
<option value=“_“>_</option>
| ID und Typ des Zugangs |
</option_list>
| Ende Informationen Zugang |
<option_list name=“formal_type“>
| Anfang Informationen Formaltyp |
<option value=“_“>_</option>
| ID und Titel des Formaltyps |
</option_list>
| Ende Informationen Formaltyp |
<option_list name=“lcode“>
| Anfang Informationen Länder |
<option value=“_“>_</option>
| Code und Titel des Landes |
</option_list>
| Ende Informationen Länder |
</dbis_search>
| Ende Suchanfrage |
</dbis_page>
| Ende Informationsausgabe |