DOIDB OAI-PMH Data Provider Beta

What is this service?

This service exposes metadata stored in the GFZ DOIDB using the Open Archives Initiative Protocol for Metadata Harvesting (OAI-PMH).

Who can use this service?

This service is open to everyone and is meant to be accessed by OAI-PMH compliant harvesters or any application that issues OAI-PMH requests. The service base address is http://doidb.wdc-terra.org/oaip/oai and the service identifier is available here.

What is OAI-PMH?

In brief, OAI-PMH provides a set of services that enables exposure and harvesting of repository metadata. The protocol is comprised of six verbs that specify the service being invoked, they are:

Identify - used to retrieve information about the repository.
ListIdentifiers - used to retrieve record headers from the repository.
ListRecords - used to harvest full records from the repository.
ListSets - used to retrieve the set structure of the repository.
ListMetadataFormats - lists available metadata formats that the repository can disseminate.
GetRecord - used to retrieve an individual record from the repository.

Selective harvesting can be performed by the use of accompanying parameters. Available parameters are:

identifier - specifies a specific record identifier.
metadataPrefix - specifies the metadata format that the records will be returned in.
set - specifies the set that returned records must belong to.
from - specifies that records returned must have been created/update/deleted on or after this date.
until - specifies that records returned must have been created/update/deleted on or before this date.
resumptionToken - a token previously provided by the server to resume a request where it last left off.

The verbs and parameters can be combined to issue requests to the service such as:

http://doidb.wdc-terra.org/igsnaaoaip/oai?verb=Identify for a repository identification
http://doidb.wdc-terra.org/igsnaaoaip/oai?verb=ListIdentifiers&metadataPrefix=oai_dc to list all registered datasets
http://doidb.wdc-terra.org/igsnaaoaip/oai?verb=ListIdentifiers&metadataPrefix=igsndescription to list all registered datasets that have a IGSN Description Schema record
http://doidb.wdc-terra.org/igsnaaoaip/oai?verb=ListIdentifiers&metadataPrefix=igsngfz to list all registered datasets that have a GFZ Description Schema record
http://doidb.wdc-terra.org/igsnaaoaip/oai?verb=ListRecords&from=2011-06-01T00:00:00Z&metadataPrefix=oai_dc to list new/updated records since 1st June 2011

For more details on the protocol, its implementation, and uses please visit the OAI-PMH web site.

Available Metadata Formats

The DataCite OAI-PMH Data Provider is able to disseminate records in the following formats:

OAI Dublin Core (oai_dc)

As a minimum requirement for OAI-PMH compliance, metadata must be made available in the OAI Dublin Core format. For more information please see the OAI-PMH web site.

OAI DataCite (oai_datacite)

This metadata format has been specifically established for the dissemination of DataCite records using OAI-PMH. In addition to the original DataCite metadata, this format contains several other elements describing the version of the metadata, whether it is of reference quality, and the registering datacentre. For more information about this format and its schema please see the Datacite OAI schema web site.

DataCite Direct (datacite)

This metadata format contains only the original DataCite metadata without additions or alterations. Because there are multiple versions of DataCite metadata in the MDS, there is no one schema that they will all adhere to. Therefore the schema for this format does not exist and metadata will not validate against it. Please note that this format is not OAI-PMH version 2.0 compliant for the previously stated reasons.

DIF

This metadata format contains geoscientific information. Further details can be found here.

Set Structure

Each DataCite allocation agency and client datacentre is represented by a set in the repository. Therefore it is easy to harvest all available metadata for a particular datacentre or allocator. In addition each set also has a reference quality equivalent (.REFQUALITY). The reference quality set limits the metadata harvested to only those records that are deemed to be of reference quality.

Arbitrary Queries

You can use custom solr search queries in your setspec. Therefore the solr query string must be base64url encoded, see RFC 4648, and appended to any normal setspec or the empty string separated by a tilde (~). There shall be no tailing padding character (=).

Example:

solr query string	`q=laser&fq=resourceTypeGeneral:dataset`
base64url	`cT1sYXNlciZmcT1yZXNvdXJjZVR5cGVHZW5lcmFsOmRhdGFzZXQK`
set name	`~cT1sYXNlciZmcT1yZXNvdXJjZVR5cGVHZW5lcmFsOmRhdGFzZXQK` `TIB~cT1sYXNlciZmcT1yZXNvdXJjZVR5cGVHZW5lcmFsOmRhdGFzZXQK` `TIB.GFZ~cT1sYXNlciZmcT1yZXNvdXJjZVR5cGVHZW5lcmFsOmRhdGFzZXQK`

Currently the solr query params q and fq are supported. For list of field names see DOIDB Search Help. At the bottom of the search results on DOIDB Search there is also a link to convert any custom query into a OAI-PMH request.

Help

If you have questions please ask ulbricht@gfz-potsdam.de

Source code / Acknowledgements

This service is based on the tools published by Datacite at GitHub. We published our modifications here.