index.rst



DH-oaipmh
OAI-PMH is the service to harvest all metadata from the collections stored in the DARIAH-DE Repository.

API Documentation

GET /oai
Every OAI request requires the parameter verb. Depending on this verb there are some required and some optional further parameters. The possible values for verb are:


Verb
Description


Identify
Some information about the repository that will be harvested


GetRecord
Get the metadata of a specific item of the repository


ListRecords
Get all records of the repository. The amount of records can be limited by other parameter. See the regarding section


ListIdentifiers
Same as the listRecords request but only the header of thes listRecords request is given


ListMetadataFormats
Shows the metadataformats supported by the repository or all metadataformats provided for a specific item


ListSets
Shows the structure of the repository


Identify Request


Parameter
Type
Description
Required


verb=Identify
String
Verb for the identify request
yes


Response

Objects belonging to a project, filter objects which are in an aggregation in same project.
Example Request

https://repository.de.dariah.eu/oaipmh/oai?verb=Identify

Example Response

GetRecord Request


Parameter
Type
Description
Required


verb=GetRecord
String
Verb for the GetRecord request
yes


identifier
URI
Identifier for the item inside the repository
yes


metadataPrefix
String
Prefix to get the items in a specific metadata format
yes


Response

Objects belonging to a project, filter objects which are in an aggregation in same project.
Example Request

https://repository.de.dariah.eu/oaipmh/oai?verb=GetRecord&identifier=11022/0000-0001-B739-1&metadataPrefix=oai_dc

Example Response

ListRecords Request


Parameter
Type
Description
Required


verb=ListRecords
String
Verb for the GetRecord request
yes


from
date
Start time of the responded items
no


to
date
End time of the responded items
no


set
String
Get just item for a specific term
no


metadataPrefix
String
Prefix to get the items in a specific metadata format
yes


resumptionToken
String
Fetching large responses in smaller parts not implemented
no


Response

Objects belonging to a project, filter objects which are in an aggregation in same project.
Example Request

https://repository.de.dariah.eu/oaipmh/oai?verb=ListRecords&metadataPrefix=oai_dc

Example Response

ListIdentifiers Request


Parameter
Type
Description
Required


verb=ListIdentifiers
String
Verb for the Listdentifiers request
yes


metadataPrefix
String
Format for the metadata response
yes


from
date
Start time of the responded items
no


to
date
End time of the responded items
no


set
String
Get just item for a specific term
no


resumptionToken
String
Fetching large responses in smaller parts not implemented
no


Response

Objects belonging to a project, filter objects which are in an aggregation in same project.
Example Request

https://repository.de.dariah.eu/oaipmh/oai?verb=ListIdentifiers&metadataPrefix=oai_dc

Example Response

ListMetadataformats Request


Parameter
Type
Description
Required


verb=ListMetadataFormats
String
Verb for the listdentifiers request
yes


identifier
URI
Identifier of the requested item
no


Response

Objects belonging to a project, filter objects which are in an aggregation in same project.
Example Request

https://repository.de.dariah.eu/oaipmh/oai?verb=ListMetadataFormats

Example Response

ListSets Request


Parameter
Type
Description
Required


verb=ListSets
String
Verb for the ListSets request
yes


resumptionToken
String
Fetching large responses in smaller parts not implemented
no


Response

Objects belonging to a project, filter objects which are in an aggregation in same project.
Example Request

https://repository.de.dariah.eu/oaipmh/oai?verb=ListSets

Example Response

Version Request
To check the current productive OAI-PMH version simply try:

https://repository.de.dariah.eu/oaipmh/oai/version

and you get the currently deployed version of the public DH-crud:

oaipmh-core-2.4.17-BETA.201611221844


Sources
See oaipmh_sources

Bugtracking
See oaipmh_bugtracking

License
See LICENCE