11
© 2016 TIB SRU-Schnittstelle TIB-Portal – Anwenderdokumentation // Version 3 // 01.02.2016 Seite 1 von 11 // Anwenderdokumentation SRU-Schnittstelle TIB-Portal

Anwenderdokumentation SRU-Schnittstelle TIB-Portal · Version Datum Bearbeiter/Autor Beschreibung der Änderungen 1 25.01.2012 Sofya Zhbankova, ITE Erste Version 2 15.02.2012 Sofya

  • Upload
    others

  • View
    12

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Anwenderdokumentation SRU-Schnittstelle TIB-Portal · Version Datum Bearbeiter/Autor Beschreibung der Änderungen 1 25.01.2012 Sofya Zhbankova, ITE Erste Version 2 15.02.2012 Sofya

© 2016 TIB SRU-Schnittstelle TIB-Portal – Anwenderdokumentation // Version 3 // 01.02.2016 Seite 1 von 11

// Anwenderdokumentation SRU-Schnittstelle TIB-Portal

Page 2: Anwenderdokumentation SRU-Schnittstelle TIB-Portal · Version Datum Bearbeiter/Autor Beschreibung der Änderungen 1 25.01.2012 Sofya Zhbankova, ITE Erste Version 2 15.02.2012 Sofya

© 2016 TIB SRU-Schnittstelle TIB-Portal – Anwenderdokumentation // Version 3 // 01.02.2016 Seite 2 von 11

Version Datum Bearbeiter/Autor Beschreibung der Änderungen 1 25.01.2012 Sofya Zhbankova, ITE Erste Version 2 15.02.2012 Sofya Zhbankova, ITE Der Link zur Vollanzeige 2.1 09.03.2012 Sofya Zhbankova, ITE Sortierung der Ergebnisse 2.2 11.02.2014 Sofya Zhbankova, ITE Format RDF-XML 3 01.02.2016 Sofya Zhbankova, ITE Dritte Version Ansprechpartner Dierk Höppner Technische Informationsbibliothek (TIB) Leitung IT-Entwicklung Welfengarten 1B 30167 Hannover Tel.: +49 511 762-4067 Fax.: +49 511 762 14237 Mobil: +49 163 762 4067

Page 3: Anwenderdokumentation SRU-Schnittstelle TIB-Portal · Version Datum Bearbeiter/Autor Beschreibung der Änderungen 1 25.01.2012 Sofya Zhbankova, ITE Erste Version 2 15.02.2012 Sofya

© 2016 TIB SRU-Schnittstelle TIB-Portal – Anwenderdokumentation // Version 3 // 01.02.2016 Seite 3 von 11

Inhalt Übersicht ......................................................................................................................................................... 4

Standards der SRU-Schnittstelle ..................................................................................................................... 4

SRU-Funktionen .............................................................................................................................................. 4

explain ......................................................................................................................................................... 4

searchRetrieve ............................................................................................................................................ 5

CQL-Contextual Query Language ................................................................................................................... 5

Das TIB spezifische Feld numbers .............................................................................................................. 7

Sortierung der Ergebnisse nach Erscheinungsjahr ..................................................................................... 7

Syntax einer SRU-Anfrage .............................................................................................................................. 8

Formate ....................................................................................................................................................... 8

Anzahl der gelieferten Datensätze pro Anfrage .......................................................................................... 8

Link zur Vollanzeige des Datensatzes in TIB-Portal ........................................................................................ 9

Anhang .......................................................................................................................................................... 10

Die Werte für das Feld format ................................................................................................................... 10

Die Werte für das Feld genreCode ............................................................................................................ 10

Die Werte für das Feld classField ............................................................................................................. 11

Page 4: Anwenderdokumentation SRU-Schnittstelle TIB-Portal · Version Datum Bearbeiter/Autor Beschreibung der Änderungen 1 25.01.2012 Sofya Zhbankova, ITE Erste Version 2 15.02.2012 Sofya

© 2016 TIB SRU-Schnittstelle TIB-Portal – Anwenderdokumentation // Version 3 // 01.02.2016 Seite 4 von 11

Übersicht Die TIB bietet eine Abfragemöglichkeit ihrer Daten über das standardisierte Webservice-Protokoll Search/Retrieve via URL1 (SRU) an. SRU ist ein technischer Standard zur einheitlichen Abfrage von Datenbanken, der insbesondere im Bereich der Bibliotheksdatenbanken verbreitet ist. SRU ist eine Weiterentwicklung des Z39.50-Protokolls und wird von der Library of Congress2 veröffentlicht. Das SRU-Protokoll ist XML basiert und verwendet die HTTP GET Methode zum Empfang und Rückgabe von SRU kompatiblen Suchanfragen und Ergebnissen. Über die Schnittstelle sind die TIB eigenen Datenbanken verfügbar. Die spezifischen Anfragen sind mittels Retrievalsprache CQL3 formuliert. Die Ergebnisse der Suche sind in verschiedenen XML-Formaten (derzeit MARCXML4, Dublin Core5, RDF-XML6) verfügbar. Standards der SRU-Schnittstelle Protokoll SRU: Version 1.2 Retrievalsprache CQL: Version 1.2 SRU-Funktionen SRU umfasst zwei Basisfunktionen: Explain und Search/Retrieve. Mindestens erforderliche Anfrageparameter der URL sind: Parameter Type Defaultwert Beschreibung operation enum explain Gewünschte SRU-Operation:

explain oder searchRetrieve

Version string 1.2 SRU-Version Je nach Operation (searchRetrieve, explain) kommen weitere Parameter hinzu. Werden keine GET-Parameter angegeben, so verhält sich der Server so, als hätte er eine Anfrage für explain erhalten. explain Die explain-Antwort enthält Informationen über:

• Datenbank • Indizes • Datenformate

Beispielanfragen:

• https://www.tib.eu/sru/tibkat • https://www.tib.eu/sru/tibkat?version=1.2&operation=explain

1 http://www.loc.gov/standards/sru/

2 http://www.loc.gov

3 http://www.loc.gov/standards/sru/specs/cql.html

4 http://www.loc.gov/standards/marcxml/

5 http://dublincore.org/

6 http://www.w3.org/TR/REC-rdf-syntax/

Page 5: Anwenderdokumentation SRU-Schnittstelle TIB-Portal · Version Datum Bearbeiter/Autor Beschreibung der Änderungen 1 25.01.2012 Sofya Zhbankova, ITE Erste Version 2 15.02.2012 Sofya

© 2016 TIB SRU-Schnittstelle TIB-Portal – Anwenderdokumentation // Version 3 // 01.02.2016 Seite 5 von 11

searchRetrieve Dies ist die eigentliche Suchoperation. Die Suchanfragen werden menschenlesbar in CQL formuliert. Neben der CQL-Anfrage sind weitere Optionen in Form von GET-Parametern nötig: Parameter Type Defaultwert Beschreibung query string Suchanfrage als CQL startRecord integer 1 Erster darzustellender

Eintrag der Ergebnisliste (beginnend mit 1) maximumRecords integer 10 Maximale Anzahl gewünschter Ergebnisse (max = 50) recordSchema string dc Das gewünschte Ausgabeformat für die Ergebnisse.

CQL-Contextual Query Language CQL ist eine formale Sprache zur Wiedergabe von Anfragen. Für die feldweise Suche werden alle transformierbaren Dublin-Core Felder benutzt. Folgende Relationen und boolsche Operatoren werden unterstützt:

• all AND-Verknüpfung • any OR-Verknüpfung • and, or

Beispiele für Anfrageformulierungen:

query=creator=James or Stirling query=creator=James and Stirling query=creator=Stirling and title=Mikro-KWK-Anlage query=creator any Stirling and date any 2001

oder in dc-Syntax:

query=dc.creator=James or Stirling query=dc.creator=James and Stirling query=dc.creator=Stirlin and dc.title=Mikro-KWK-Anlage query=dc.creator any Stirling and dc.date any 2001

Ohne Eingabe des CQL-Dublin-Core-Feldes (entspricht cql.serverChoice) wird in den folgenden Feldern gesucht: Titel, alternative Titel, Subtitel, Journal Titel, Konferenztitel, Autor, Publikationscodes (ISSN, ISBN uzw.), Identifikatoren (PPN7, FTX-ID), Schlüsselworte, Abstract, Volltext, Publisher und Erscheinungsjahr.

7 PPN steht für Pica Produktionsnummer. Das ist die Indentnummer für Datensätze in Pica-basierten Katalogsystemen.

Siehe OCLC.

Pica ist ein Katalogsystem, das von OCLC (http://www.oclc.org/de/de/default.htm) vertrieben wird.

Page 6: Anwenderdokumentation SRU-Schnittstelle TIB-Portal · Version Datum Bearbeiter/Autor Beschreibung der Änderungen 1 25.01.2012 Sofya Zhbankova, ITE Erste Version 2 15.02.2012 Sofya

© 2016 TIB SRU-Schnittstelle TIB-Portal – Anwenderdokumentation // Version 3 // 01.02.2016 Seite 6 von 11

Die Tabelle stellt ein Mapping für CQL-Dublin-Core Felder und TIB spezifisch durchsuchbare "Felder" dar: CQL-Felder (Kontext) TIB spezifisch durchsuchbare Felder (ohne Eingabe) oder cql.serverChoice serverChoice

mainTitle, alternativeTitle, subTitle, journalTitle, keywords, abstract, fulltext, author, issued, numbers8, conference, publisher

title dc.title

mainTitle, alternativeTitle, subTitle, journalTitle

creator dc.creator

author

date dc.date

issued (Jahresangabe)

description dc.description

abstract, fulltext

identifier dc.identifier

id (FTX-ID / TIB spezifische Identnummer)

subject dc.subject

keywords

volume volumeNumber

issue issueNumber

firstPage firstPage

license licenseModel

numbers numbers

ppn resolveId

coverDate coverDate

classField classification

genreCode documentGenreCode

format documentTypeCode

journal journalTitle Die Werte für die Felder genreCode, format und classField finden Sie im Anhang. Beispiele:

genreCode=JL format=PR

Die Werte für license : Bezeichnung Suchbegriff

Open-Access-Dokumente (Freier Zugriff) oa

kommerzielle Dokumente com

Dokumente mit Nationallizenz nl

8 Suche in numbers siehe Abschnitt Das TIB spezifische Feld numbers

Page 7: Anwenderdokumentation SRU-Schnittstelle TIB-Portal · Version Datum Bearbeiter/Autor Beschreibung der Änderungen 1 25.01.2012 Sofya Zhbankova, ITE Erste Version 2 15.02.2012 Sofya

© 2016 TIB SRU-Schnittstelle TIB-Portal – Anwenderdokumentation // Version 3 // 01.02.2016 Seite 7 von 11

Das TIB spezifische Feld numbers Im TIB spezifischen Feld numbers verstecken sich folgende Identifikatoren und Codes: PPN, ISSN, EISSN, ISBN13, ISBN usw. Eingabe mit oder ohne Bindestriche. Beispiele:

1. Suche nach PPN = 129110248 query=129110248 oder query=ppn=129110248

2. Suche nach ISBN = 0952701111

query=0952701111 3. Suche nach ISSN = 0165-6074

query=0165-6074 query=01656074

Wichtig! Diese Anfragen bei der Suche nach ISBN oder ISSN führen nicht zum gewünschten Ergebnis:

• query=identifier=0952701111 oder query=isbn=0952701111 • query=identifier=0165-6074 oder query=issn=0165-6074

Sortierung der Ergebnisse nach Erscheinungsjahr Die Ergebnismenge kann mit dem Schlüsselwort sortBy in absteigender und aufsteigender Reihenfolge (sort.descending, sort.ascending) nach Erscheinungsjahr sortiert werden. Beispiele:

1. Suche nach 'solid' mit der Sortierung absteigend nach Erscheinungsjahr query=solid sortBy dc.date/sort.descending

2. Suche nach 'solid' mit der Sortierung aufsteigend nach Erscheinungsjahr query=solid sortBy dc.date/sort.ascending query=solid sortBy dc.date

Page 8: Anwenderdokumentation SRU-Schnittstelle TIB-Portal · Version Datum Bearbeiter/Autor Beschreibung der Änderungen 1 25.01.2012 Sofya Zhbankova, ITE Erste Version 2 15.02.2012 Sofya

© 2016 TIB SRU-Schnittstelle TIB-Portal – Anwenderdokumentation // Version 3 // 01.02.2016 Seite 8 von 11

Syntax einer SRU-Anfrage Beispielanfrage9: https://www.tib.eu/sru/tibkat?version=1.2&operation=searchRetrieve&query=title=solid&startRecord=1&maximumRecords=5&recordSchema=marcxml URL-Bestandteil Erklärung https://tib.eu/sru/tibkat Anfrage an den SRU-Server der TIB. Es ist

grundsätzlich nur die Nutzung des HTTPS-Protokolls möglich

?version=1.2 Angabe der SRU-Version (Standard) . Es wird nur die Version 1.2 unterstützt

&operation=searchRetrieve Befehl an den Server &query= Anfrage formulieren &startRecord=1 Erster darzustellender Eintrag der Ergebnisliste &maximumRecords=5 Maximale Anzahl den Datensätzen pro Anfrage &recordSchema=marcxml Gewünschtes Format der SRU-Antwort

Formate Folgende Formate werden angeboten: Format Wert im SRU-Anfrage-Parameter recordSchema

MARC-21-XML marcxml

Dublin core (Auswahl von Dublin-Core-Elementen)

dc

RDF_XML rdf_xml

Dublin Core Extension dcx

Anzahl der gelieferten Datensätze pro Anfrage

• Standard: 10 Datensätze pro Antwort Maximal: 50 Datensätze pro Antwort

• Abruf weiterer Datensätze: &startRecord=51 (mögliche Werte 1 bis unendlich)

9 Zeilenumbrüche dienen nur der Lesbarkeit und sind nicht Teil des Internetlinks!

Page 9: Anwenderdokumentation SRU-Schnittstelle TIB-Portal · Version Datum Bearbeiter/Autor Beschreibung der Änderungen 1 25.01.2012 Sofya Zhbankova, ITE Erste Version 2 15.02.2012 Sofya

© 2016 TIB SRU-Schnittstelle TIB-Portal – Anwenderdokumentation // Version 3 // 01.02.2016 Seite 9 von 11

Link zur Vollanzeige des Datensatzes in TIB-Portal Der Link zur Vollanzeige des Datensatzes in TIB-Portal wird nach dieser Regel erstellt:

https://www.tib.eu/de/suchen/id/<FTX-ID>

Zum Beispiel: für Datensatz mit der FTX-ID = TIBKAT:506054543

• https://www.tib.eu/de/suchen/id/TIBKAT:506054543 oder

• https://www.tib.eu/de/suchen/id/TIBKAT%3A506054543 Im MarcXML-Format enthält der Datensatz diesen Link im Feld 500 (subfield code="a"):

<datafield ind1=" " ind2=" " tag="500"> <subfield code="a">https://www.tib.eu/de/suchen/id/TIBKAT%3A506054543</subfield> </datafield>

Page 10: Anwenderdokumentation SRU-Schnittstelle TIB-Portal · Version Datum Bearbeiter/Autor Beschreibung der Änderungen 1 25.01.2012 Sofya Zhbankova, ITE Erste Version 2 15.02.2012 Sofya

© 2016 TIB SRU-Schnittstelle TIB-Portal – Anwenderdokumentation // Version 3 // 01.02.2016 Seite 10 von 11

Anhang Die Werte für das Feld format Bezeichnung Suchbegriff CD-ROM / DVD CD

Elektronische Ressource EL

Mikroform MF

Print PR

Audiovisuelles Material AV

Digitalisat DC Die Werte für das Feld genreCode Bezeichnung Suchbegriff Audiovisuelles Material A

Buch B

Aufsatz/Kapitel (Buch) BC

Konferenzband C

Aufsatz (Konferenz) CA

Hochschulschrift D

Forschungsdaten FD

Bild I

Zeitschrift J

Aufsatz (Zeitschrift) JL

Karte K

Artikel (Lexikon) LA

3D-Modell M

Patent P

Paper PA

Technische Regel S

Report R

Audio-Material T

Page 11: Anwenderdokumentation SRU-Schnittstelle TIB-Portal · Version Datum Bearbeiter/Autor Beschreibung der Änderungen 1 25.01.2012 Sofya Zhbankova, ITE Erste Version 2 15.02.2012 Sofya

© 2016 TIB SRU-Schnittstelle TIB-Portal – Anwenderdokumentation // Version 3 // 01.02.2016 Seite 11 von 11

Die Werte für das Feld classField Bezeichnung Suchbegriff Architektur arc

Chemie che

Informatik inf

Mathematik mat

Physik phy

Technik tec

Biologie bio

Erziehungswissenschaften pae

Gartenbau hor

Geowissenschaften geo

Geschichte his

Linguistik lin

Literaturwissenschaften lit

Philosophie phy

Recht jur

Theologie rel

Sozialwissenschaften sow

Sport spo

Wirtschaftswissenschaften oek