Inhalt

Overview

OAI-PMH(OAI-Protocol for Metadata Harvesting) provides an efficient exchange of Metadata in its own standardized OAI format so called OAI protocol. The data are provided by the internal databases (data providers). The collected records are then processed by service providers and provided for search queries. The OAI harvester is working with simple HTTP GET requests and HTTP POST. The HTTP response provides the record data from the data providers in various formats.

TIB offers a search option to their data via OAI interface.

Each user is qualified to retrieve open access documents via OAI interface from TIB. The fee-basedmetadata are only accessible to authorized users. The above mentioned metadata are made availableby the OAI interface. The metadata is provided by different content and formal criteria so-called “Sets”. These Sets can be delivered by previous mentioned procedure using internal datbase collections. The Sets are divided into two different request methods so called “static Sets” and “dynamic Sets”.

Standards of OAI interface

We offer OAI protocol OAI-PMH Version 2.0. This protocol is based on well-known and popular standards.

This documentation will only give you an basic overview of the protocol. Please consult the standard for more information.

OAI request types

There are six different OAI inquiry request types. They should be selected by the values of the URLparameter "verb".

FunctionDescription
IdentifyDisplay of general information about the repository
ListSetsDelivers all available standing data sets (collections)
ListMetadaFormatsListing of all data formats available in the repository
ListIdentifiersList of unique identifiers of records
ListRecordsRecords of the archive
GetRecord

To select only one record

(warning) The part after "oai:tib.eu:" in the record identifier must be URL encoded the same way as in Direktlink zur Detail-Ansicht eines Dokuments im TIB-Portal.

Example queries:

https://www.tib.eu/oai/public/repository/open?verb=Identify

https://www.tib.eu/oai/public/repository/open?verb=ListSets

https://www.tib.eu/oai/public/repository/open?verb=ListMetadataFormats

https://www.tib.eu/oai/public/repository/open?verb=ListIdentifiers&metadataPrefix=oai_dc

https://www.tib.eu/oai/public/repository/open?verb=ListRecords&metadataPrefix=oai_dc&set=tibkat

ListRecords

As an example we cover the most important request type “ListRecords”. It supports the following arguments:

ArgumentDescriptionRequest Example
metadataPrefixa required argument. Specifies the metadata format returned. See section “Format” for the formats provides by TIB .verb= ListRecords & metadataPrefix =oai_dc
froman otional argument, which specifies a lower bound for datestamp-basedverb= ListRecords & from =2010-01-01
untilan optional argument, whichh specifies a upper bound for datestamp-basedverb= ListRecords & until =2016-01-01
setan optional argument with a setSpec value, wich specifices set criteria for selective harvestingverb= ListRecords & set =tibkat
resumptionTokenAn exclusive argument with a value returned by the previous ListRecords, to retrieve the next records of an incomplete list.An exclusive argument with a value returned by the previous ListRecords, to retrieve the next records of an incomplete list.

Example queries:

https://www.tib.eu/oai/public/repository/open?verb=ListRecords&metadataPrefix=oai_dc&from=2020-01-01&until=2020-08-01&set=tibkat

What data sets does the TIB provide?

Static Sets

The TIB provides its own static sets which correspond to data deliverer. The list of our static sets can be retrieved via the following URL:

https://www.tib.eu/oai/public/repository/open?verb=ListSets

Dynamic Sets

The TIB offers a special syntax for Sets we call “Dynamic Sets”. By this special syntax it is possible to create more complex queries for the service provider.

The syntax for dynamic Set names can be seen in the following template:

collection~<set>_solr~<search>

The following components of the Set names must be included:

ParameterDescription
setOne normal set name (e.g. “tibkat”) or for all records use “all” or “*”
searchSearch query. The syntax corresponds to the syntax of the TIB Portal ( www.tib.eu ).

Example queries:

If you want to search for all records matching the term “laser” the set name would be the following:    collection~*_solr~laser

https://www.tib.eu/oai/public/repository/open?verb=ListRecords&metadataPrefix=oai_dc&from=2012-10-09&set=collection~*_solr~laser

General information of the TIB OAI server

InformationReadings
Number of the delivered records per answer100 records
Time specificationtime specified in Coordinated Universal Time UTC
Period for the selective Harvestingdays accuracy (YYYY-MM-DD)
Deleted recordsDeleted Record Policy: no
FormatStandard: Dublin Core
SetsListSets
EncodingAs mentioned below formats are offered in the UTF-8 coding!

Format

The following formats can be in principal requested from our OAI interface. Only the ones marked with “for all users” are accessible to every user. If you required one the other formats please make an inquiry to our customer service.

FormatAvailabilityDescription
oai_dcfor all usersDublin Core, free format
dcxon inquiryDublin Core Extension
bibtexon inquiryBibTex
dataciteon inquiryDatacite Format

on inquiryLinked Open Data (LOD)
marc_xmlfor all usersMarc-21-Xml
rdf_xmlfor all usersRDF_XML
rison inquiryResearch Information System Format
ftxon inquiryTIB internal format

Example queries:

https://www.tib.eu/oai/public/repository/open?verb=ListRecords&metadataPrefix=oai_dc

OAI endpoint

The following OAI endpoints are public and can be used by all users:

Permitted format for public entpoint 'open': oai_dc, marc_xml, rdf_xml, rdf_n3, rdf_json, rdf_turtle, rdf_jsonld .

Customer specific endpoints

If you are a new customer and you are interested in all TIB data in various data formats as well as OAI desired sets, you need to create a free of charge TIB customer account and get in touch with our customer service.

If our customer service approves you request you will receive an email including your Universally Unique Identifier (UUID).

With your personal UUID you are able to query the open access documents and also the fee-based metadata you are allowed to. For more details, please contact our customer service.

How do I use my private UUID ?

As soon as you receive your UUID you are able to harvest data from the TIB in the format TIB has approved.

Your private UUID is then an integrated part of the base URL. It will the resolve the url path element “open” in all previous urls.

Example: https://www.tib.eu/oai/public/repository/XxXxXxXxXxX?verb=ListRecords&metadataPrefix=oai_dc

Special Set settings

If necessary, special sets can be configured for customers to retrieve the agreed records.

The customer can request up to five different special sets, which will be configured by our customer service. They are normally names “all1” to “all5”.

For each special set it is possible to combine and configure different formats and search fields or different criteria like license model, publication date, etc.

Search fields in dynamic sets

In addition to a „free text” search query it is possible to query some search field individually as shown below: documentType, issued, isbn, issn, ppn, licenseModel,  author, mainTitle, Abstract, Dclassification.

Some search fields have specific values which can be used to receive different documents types. Those are explained in the following sections.

Example queries:

https://www.tib.eu/oai/public/repository/open?verb=ListRecords&metadataPrefix=oai_dc&from=2012-10-09&set=collection~*_solr~documentType:B issued:2000 licenseModel:oa

https://www.tib.eu/oai/public/repository/open?verb=ListRecords&metadataPrefix=oai_dc&set=collection~tibkat_solr~issued:2010

DdocumentType

Example queries: DdocumentType:A

ValueSearch fields
AAudiovisual material
BBook
BCEssay/chapter(book)
CProceedings
CAConference
DTheses
FDResearch data
IImage
JMagazin
KMap
JLArticle (journal)
PPPreprint
LAArtikel (Lexikon)
M3D-Model
PPatent
PAPaper
RReport
STechnical rule
TAudio-Material


DlicenseModel

Example queries:DlicenseModel:oa

Value

Search fields

alAlliance licence
klConsortial licence

oa

Open-Access- Document (Free Access)

com

Commercial documents

nl

Documents with National License

Dclassification

Example queries: Dclassification:tec

Value

Search fields

arc

Architecture

che

Chemistry

inf

Computer science

mat

Mathematics

phy

Physics

tec

Technology

bioBiology
paeEducation
horHorticulture
geoEarth sciences
hisHistory
linLinguistics
litLiterature
phiPhilosophy
jurRight
relTheology
sowSocial sciences
spoSport
oekEconomics

Use and reference conditions

Since July 15, 2016 all catalogue records (oai set “tibkat”) are available for free use under "CreativeCommons Zero” conditions (CC0 1.0). For all other oai sets please request license information via the TIB customer service.

The TIB offers no guarantee that the metadata and online interfaces will be uninterrupted, complete,and that they do not violate rights of third parties (eg as publicity or copyrights).

Contact

Customer service:   Monday to Friday from 08:00 to 16:30

T el.: +49 0511 762-8989

  • No labels