Skip to content

DBC OAI Repo

Allan Forsberg edited this page Nov 19, 2020 · 2 revisions

DBC OAI Repo

DBC OAI Repo provides an interface to harvest metadata from DBC's Open Search data well. Data OAI Repo contains data from the raw repo, which means that the records are available in their original, raw form, and not consolidated.

DBC OAI Repo is based on version 2.0 of the OAI-PHM standard. In the terminology of OAI-PMH, DBC OAI Repo is a data provider/repository.

Endpoints

URL Data repository version Environment
https://oai.addi.dk/oai 3.5 production
https://oai.test.addi.dk/oai 3.5 test

How to use DBC OAI Repo

DBC OAI Repo works as specified in the OAI-PHM Version 2.0 Specification.

Below is a list of examples that should serve as a quick introduction to the interface and possibilities of DBC OAI Repo.

Authentication

Some data sets require subscription and therefore authentication is required to obtain these. Authenticate by using the identity-parameter with the Netpunkt-triple (syntax: user:group:password) of your institution:

https://oai.test.addi.dk/oai?verb=ListRecords&metadataPrefix=marcx&set=bkm&identity=netpunkt:100200:password

Operations (OAI verbs)

Identity

Basic information about the repository:

https://oai.test.addi.dk/oai?verb=Identify

ListSets

Information about available data sets in the repositories:

https://oai.test.addi.dk/oai?verb=ListSets

ListMetaDataFormats

Available metadata formats:

https://oai.test.addi.dk/oai?verb=ListMetadataFormats

The available format, marcx, refers to danMARC2 in MarcXchange 1.1 format.

ListRecords

This is the main function of DBC OAI Repo and is used to harvest records.

https://oai.test.addi.dk/oai?verb=ListRecords&metadataPrefix=marcx

The metadataPrefix parameter is mandatory. Possible values are retrieved with ListMetadataFormats.

The parameters from and until can be used to define a date interval for the harvested records:

https://oai.test.addi.dk/oai?verb=ListRecords&from=2017-05-01T14:15:00Z&until=2017-05-16T14:15:00Z&metadataPrefix=marcx

Specify a set (set names are retrieved using ListSets) using the parameter set. If no set name is specified, records from all available sets are retrieved.

https://oai.test.addi.dk/oai?verb=ListRecords&metadataPrefix=marcx&set=nat

A maximum of 100 records can be harvested with each call. If further records are available within the defined set, a resumptionToken is returned. Call ListRecords with the token to retrieve the next records in the sets. Please note that the resumptionToken must be URL-encoded when used in a request:

https://oai.test.addi.dk/oai?verb=ListRecords&metadataPrefix=marcx&resumptionToken=puVGB_awGlYt30qeo-OGXEdZl6eaw2oFRqFFYCYGPYx8kphi6NHnex_teazKr0uYR0_5j6mtC3A=

If the resumptionToken-element is not present, all available records have been retrieved.

ListIdentifiers

To only retrieve identifiers but not actual records, use ListIdentifiers. Use and options are the same as for ListRecords.

https://oai.test.addi.dk/oai?verb=ListIdentifiers&metadataPrefix=marcx

GetRecord

A specific record can be retrieved by its identifier using getRecord:

https://oai.test.addi.dk/oai?verb=GetRecord&identifier=870970-29372373&metadataPrefix=marcx

Example of a volume record that will be retrieved together with its main record when metadata format is marcx:

https://oai.test.addi.dk/oai?verb=GetRecord&identifier=870970-28329490&metadataPrefix=marcx