EZB-OA-Schnittstelle
Link zur Schnittstelle: https://ezb.ur.de/api/oa_rights
1. Was ist die OA-EZB-Schnittstelle?
Allianz, National- oder Konsortiallizenzen enthalten oft Open-Access-Rechte (OA-Rechte) zur Zweitveröffentlichung von Vollexten (z.B. über ein Repositorium). Die OA-EZB-Schnittstelle stellt die in der EZB hinterlegten OA-Rechte zur freien Nachnutzung bereit.
Die in dieser Schnittstelle bereitgestellten OA-Rechte aus Allianz, National- und Konsortiallizenzen werden in der EZB von Paketverwaltern (die i.d.R. auch Verhandlungsführer sind) hinterlegt. Diese pflegen zudem auch die zur Lizenz gehörenden Teilnehmereinrichtungen samt zugehöriger Zeitschriftentitel in der EZB.
2. Welche Formate können ausgegeben werden?
Die Ausgabe der angefragten Daten erfolgt wahlweise über JSON oder XML. Der Schnittstellennutzer legt hierzu den Parameter format entweder auf den Wert application/json oder application/xml.
3. Schnittstelle 1: Allgemeine Ausgabe der Open-Access-Rechte (OA-Rechte)
Anhand der übergebenen Parameter package_id oder collection_id werden alle OA-Rechte allgemein ausgegeben, die für das entsprechende Paket bzw. die entsprechende Kollektion in der EZB hinterlegt sind.
3.1 Übergabeparameter
Folgende Parameter können der Schnittstelle übergeben werden:
| Übergabeparameter | Werte | Standardwert | Erläuterung |
|---|---|---|---|
| lang | ‚de‘ und ‚en‘ | ‚de‘ | [optional] Sprache |
| package_id | [A-Z0-9]{3,5} | – | [Wahlpflicht a*] Paket-ID. Entweder muss package_id oder collection_id übergeben werden |
| collection_id | ‚EZB-XXXX-00000‘ | – | [Wahlpflicht b*] EZB-Identifikator. Entweder muss package_id oder collection_id übergeben werden |
| format | ‚application/xml‘ und ‚application/json‘ | – | [verpflichtend] Format der Datenausgabe. |
*Wahlpflicht heißt, dass einer der genannten Parameter übergeben werden muss.
3.2 Ausgabefelder
Die OA-Rechte können für ein gesamtes EZB-Zeitschriftenpaket (z.B. Allianz-Lizenzpaket) hinterlegt werden. Gelten für bestimmte Kollektionen oder Zeitschriftentitel eigene OA-Rechte, können diese gesondert auf Kollektions- bzw. Zeitschriftentitelebene erfasst werden. Bei der Ausgabe erfolgt eine hierarchische Gliederung der OA-Rechte nach Paket- Kollektions- und Zeitschriftenebene.
Folgende Felder formen die Datenausgabe der Schnittstelle:
| Feld | Feldbeschreibung |
|---|---|
| oa_level | Feld zur Ausgabe der Ebene, auf der OA-Rechte vergeben wurden. Das oa_level kann entweder ‚package‘ (OA-Recht-Vergabe auf Paketebene), ‚collection‘ (gesonderte OA-Recht-Vergabe auf Kollektionsebene) oder ‚journal‘ (gesonderte OA-Recht-Vergabe auf Zeitschriftenebene) sein. Die Ausgabe erfolgt hierarchisch. |
| oa_lfnr | Laufende Nummer des OA-Rechts (interner Identifier) |
| oa_first_date | Beginn Zeitraums mit OA-Rechten |
| oa_last_date | Ende des Zeitraums mit OA-Rechten |
| oa_embargo_months | Angabe des Zeitraums in Monaten, der bis zur Zweitveröffentlichung berücksichtigt werden muss |
| oa_pub_authority | Angabe, wer das Recht zur Zweitveröffentlichung hat, z.B. Autor |
| oa_archivable_version | Angabe, welche Version der Publikation zweitveröffentlicht werden darf, z.B. Pre-Print-Dokument |
| oa_repositories | Angabe, wo die Zweitveröffentlichung erfolgen kann, z.B. Website des Autors |
| oa_source | Angabe, aus welche Quelle die Publikation zur Zweitveröffentlichung stammen muss, z.B. Bezug über Autor |
| remarks_de | Anmerkungen zum OA-Recht auf Deutsch |
| remarks_en | Anmerkungen zum OA-Recht auf Englisch |
| oa_last_change | Datum der letzten Änderung |
3.3 Beispiele
Abfrage der OA-Rechte für das Zeitschriftenpaket mit der EZB-PaketID ‚NALIX‘
Welche OA-Rechte sind für das Deutsche Nationallizenz ‚Walter de Gruyter Online-Zeitschriften Archiv‘ mit der EZB-PaketID ‚NALIX‘ eingetragen? Auf welchen Ebenen sind OA-Rechte hinterlegt?
https://ezb.ur.de/api/oa_rights?lang=de&package_id=NALIX&format=application/json
Abfrage der für die Kollektion mit der KollektionsID ‚EZB-NALIX-00498‘ hinterlegten OA-Rechte
Welche OA-Rechte sind für die Kollektion ‚Walter_de_Gruyter_Online-Zeitschriften_Archiv_NL‘ mit der EZB KollektionsID ‚EZB-NALIX-00498‘ eingetragen? Auf welchen Ebenen sind OA-Rechte hinterlegt?
https://ezb.ur.de/api/oa_rights?lang=en&collection_id=EZB-NALIX-00498&format=application/json
4. Schnittstelle 2: Institutions- und zeitschriftenspezifische Ausgabe der Open-Access-Rechte (OA-Rechte)
Anhand der übergebenen Parameter bibid, issn, doi, title und/oder year wird geprüft, ob für den angefragten Artikel in der angefragten Bibliothek OA-Rechte aus Allianz, National- oder Konsortiallizenzen in der EZB hinterlegt sind.
Beispielanfrage:
https://ezb.ur.de/api/oa_rights?bibid=UBR&issn=1938-2650&year=2013&format=application/json
4.1 Übergabeparameter
Folgende Parameter können der Schnittstelle übergeben werden:
| Übergabeparameter | Werte | Standardwert | Erläuterung |
|---|---|---|---|
| lang | ‚de‘ und ‚en‘ | ‚de‘ | [optional] Sprache der Datenausgabe |
| bibid | [A-Z0-9]{3,5} | – | [verpflichtend] EZB-Kennung der Einrichtung für die OA-Rechte abgefragt werden |
| year | z.B. 2018 oder 2018-12-11 | – | [optional] Jahreszahl oder Datum ‚Y-m-d‘ einer Ressource, für die OA-Rechte abgefragt werden |
| issn | ‚XXXX-XXXX‘ oder ‚XXXXXXXXX‘ | – | [Auswahlpflicht a*] eISSN oder pISSN einer Zeitschrift, für die OA-Rechte abgefragt werden |
| doi | z.B. ‚10.1000/xyz123‘ | – | [Auswahlpflicht b*] Digital Object Identifier (DOI) einer Ressource, für die OA-Rechte abgefragt werden |
| title | ‚Die Beispielszeitschrift‘ | – | [Auswahlpflicht c*] Titel einer Zeitschrift, für die OA-Rechte abgefragt werden |
| format | ‚application/xml‘ und ‚application/json‘ | – | [verpflichtend] Format der Datenausgabe |
*Auswahlpflicht heißt, dass einer der genannten Parameter übergeben werden muss. Wird die ISSN übergeben, werden die anderen Wahlpflicht-Parameter ignoriert.
4.2 Ausgabefelder
Folgende Felder formen die Datenausgabe der Schnittstelle:
| Feld | Feldbeschreibung |
|---|---|
| state | Feld zur Ausgabe des Statuscodes Die Beschreibung aller Statuscodes wird unter Punkt 4.3 aufgelistet. |
| message | Feld zur Ausgabe des Statuscodes in Textform |
| institution_id | EZB-BIBID der angefragten Einrichtung |
| institution_name | Name der angefragten Einrichtung |
| issn | ISSN der angefragten Zeitschrift |
| oa_agreement | Name der Lizenz, die das ausgegebene OA-Recht enthält |
| oa_package_name | EZB-PaketID der Lizenz, die das ausgegebene OA-Recht enthält |
| oa_lfnr | Laufende Nummer des OA-Rechts (interner Identifier) |
| oa_level | Feld zur Ausgabe der Ebene, auf der OA-Rechte vergeben wurden (Vergabe auf Paket-, Kollektions- und Zeitschriftenebene möglich) |
| oa_first_date | Beginn Zeitraums mit OA-Rechten |
| oa_last_date | Ende des Zeitraums mit OA-Rechten |
| oa_embargo_months | Angabe des Zeitraums in Monaten, der bis zur Zweitveröffentlichung berücksichtigt werden muss |
| oa_pub_authority | Angabe, wer das Recht zur Zweitveröffentlichung hat, z.B. Autor |
| oa_archivable_version | Angabe, welche Version der Publikation zweitveröffentlicht werden darf, z.B. Pre-Print-Dokument |
| oa_repositories | Angabe, wo die Zweitveröffentlichung erfolgen kann, z.B. Website des Autors |
| oa_source | Angabe, aus welche Quelle die Publikation zur Zweitveröffentlichung stammen muss, z.B. Bezug über Autor |
| remarks_de | Anmerkungen zum OA-Recht auf Deutsch |
| remarks_en | Anmerkungen zum OA-Recht auf Englisch |
4.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) |
|---|---|---|
| 0 | OA-Verwertungsrechte vorhanden. | OA rights available. |
| 1 | Es sind OA-Verwertungsrechte für den angefragten Zeitraum hinterlegt | OA rights available for the requested period. |
| 2 | Für Ihre Anfrage sind keine OA-Verwertungsrechte in der EZB hinterlegt | No OA rights available. |
| 3 | Es sind keine OA-Verwertungsrechte für den angefragten Zeitraum in der EZB hinterlegt | No OA rights available. |
| 3 | Es sind keine OA-Verwertungsrechte für den angefragten Zeitraum in der EZB hinterlegt | No rights available for the requested period. |
| 4 | ISSN von OA-Klausel ausgeschlossen. | ISSN excluded from OA right. |
| 5 | Zu dieser DOI konnte keine passende ISSN gefunden werden | No matching ISSN could be found for this DOI. |
| 6 | Zu diesem Zeitschriftentitel konnte keine passende ISSN gefunden werden | No matching ISSN could be found for this journal title. |
| 7 | – | – |
| 8 | Für Ihre Anfrage sind keine OA-Rechte in der EZB hinterlegt | No entries could be found for this ISSN in the EZB. |
| 9 | Für Ihre Anfrage sind keine Informationen in der EZB hinterlegt | There is no information provided in the EZB for your request. |
4.4 Beispiele
Abfrage anhand der ISSN, XML-Ausgabe
Liegen für die Zeitschrift mit der ISSN 1938-2650 an der UB Regensburg (EZB-BIBID: UBR) für das Jahr 2016 OA-Rechte vor?
https://ezb.ur.de/api/oa_rights?bibid=UBR&issn=1938-2650&year=2016&format=application/json
Abfrage anhand der DOI, JSON-Ausgabe
Liegen für den Zeitschriftenartikel mit der DOI 10.1159/000447733 
an der UB Regensburg (EZB-BIBID: UBR) OA-Rechte vor? Die Datenausgabe soll auf Englisch und als JSON erfolgen.
https://ezb.ur.de/api/oa_rights?bibid=UBR&doi=10.1159/000447733&lang=en&format=application/json
Abfrage anhand des Zeitschriftentitels
Liegen für die Zeitschrift ‚Aggression and Violent Behavior‘ an der UB Regensburg (EZB-BIBID: UBR) für das Jahr 2018 OA-Rechte vor?
https://ezb.ur.de/api/oa_rights?bibid=UBR&title=Aggression%20and%20Violent%20Behavior&year=2018&format=application/json
5. Welche Ausgabeoptionen stehen zur Verfügung?
Die folgenden Felder verfügen über standardisierte, mehrfache Ausgabemöglichkeiten:
| Feld | Deutsch | Englisch |
|---|---|---|
| oa_level |
|
|
| oa_pub_authority |
|
|
| oa_archivable_version |
|
|
| oa_repositories (Ausgabe mehrerer Optionen möglich) |
|
|
| oa_source (Ausgabe mehrerer Optionen möglich) |
|
|
6. Wie können Open-Access-Rechte (OA-Rechte) in institutionelle Repositorien eingebunden werden?
OA-Rechte, die in der EZB hinterlegt sind, lassen sich z.B. auch in institutionellen Repositorien einbinden. Für EPrints-Repositorien wurde dazu ein Plug-in entwickelt. Es besteht aus drei Modulen, die sich getrennt voneinander konfigurieren lassen. Das erste Modul greift auf die OA-EZB-Schnittstelle zu und gibt die Informationen über in der EZB hinterlegte Zweitveröffentlichungsrechte z.B. für Allianz-Lizenzen in einer Übersicht aus. Das zweite Modul ruft verlagsseitige OA-Policies in SHERPA/RoMEO ab. Im dritten Modul wird ein Hinweis auf das deutsche Zweitveröffentlichungsrecht gemäß Urheberrechtsgesetz ausgegeben. Im Frontend des EPrints-Repositoriums erscheinen die abgerufenen Daten aller Module an einer zuvor definierten Stelle, beispielsweise vor dem Hochladen eines Artikels.
Das EPrints-Plugin sowie weitere Informationen dazu finden Sie hier: https://github.com/ub-regensburg/OA-EZB
7. An wen kann ich mich wenden, wenn ich Anmerkungen habe oder Fehler auftreten?
Es gibt eine Mailingliste, die sich an alle EZB-Datenbezieher richtet. Hier erhalten Sie servicespezifische Informationen vom EZB-Team. Zudem haben Sie die Möglichkeit, sich mit weiteren EZB-Datenbeziehern über Fragen bei der Anwendung auszutauschen, eigene Ideen einzubringen und neue Ansätze zu diskutieren.
Link zur Anmeldung: https://www.listserv.dfn.de/sympa/info/ur-ub-ezb-dbis-data
Für den Fall, dass Sie einen Fehler beobachtet haben, senden Sie bitte eine E-Mail an: info.ezb@ur.de