DH-oaipmh¶
OAI-PMH is the service to harvest all metadata from the collections stored in the DARIAH-DE Repository.
API Documentation¶
#VERSION¶
To check the current productive OAI-PMH version simply try:
and you get the currently deployed version of the public DH-crud:
oaipmh-core-2.4.17-BETA.201611221844
#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
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
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
Example Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:ns2="http://purl.org/dc/elements/1.1/"
xmlns:ns3="http://www.openarchives.org/OAI/2.0/oai_dc/">
<responseDate>2017-02-15T15:58:08Z</responseDate>
<request verb="ListRecords" metadataPrefix="oai_dc">repository.de.dariah.eu</request>
<ListRecords>
<record>
<header>
<identifier>hdl:11022/0000-0001-3279-F</identifier>
<datestamp>2016-09-07T15:19:12Z</datestamp>
</header>
<metadata>
<ns3:dc>
<ns2:creator>fugifu</ns2:creator>
<ns2:date>2016-09-07T15:19:12Z</ns2:date>
<ns2:format>image/jpeg</ns2:format>
<ns2:identifier>http://repository.de.dariah.eu/dhcrud/11022/0000-0001-3279-F/metadata</ns2:identifier>
<ns2:identifier>http://repository.de.dariah.eu/dhcrud/11022/0000-0001-3279-F/data</ns2:identifier>
<ns2:identifier>hdl:11022/0000-0001-3279-F</ns2:identifier>
<ns2:relation>dariah:collection:11022/0000-0001-326F-B</ns2:relation>
<ns2:rights>fugifu</ns2:rights>
<ns2:title>MI1Comic-01.jpg</ns2:title>
</ns3:dc>
</metadata>
</record>
<record>
<header>
<identifier>hdl:11022/0000-0001-327D-B</identifier>
<datestamp>2016-09-07T15:19:24Z</datestamp>
</header>
<metadata>
<ns3:dc>
<ns2:creator>fugifu</ns2:creator>
<ns2:date>2016-09-07T15:19:24Z</ns2:date>
<ns2:format>image/gif</ns2:format>
<ns2:identifier>http://repository.de.dariah.eu/dhcrud/11022/0000-0001-327D-B/metadata</ns2:identifier>
<ns2:identifier>http://repository.de.dariah.eu/dhcrud/11022/0000-0001-327D-B/data</ns2:identifier>
<ns2:identifier>hdl:11022/0000-0001-327D-B</ns2:identifier>
<ns2:relation>dariah:collection:11022/0000-0001-326F-B</ns2:relation>
<ns2:rights>fugifu</ns2:rights>
<ns2:title>StoneGolem.gif</ns2:title>
</ns3:dc>
</metadata>
</record>
<record>
<header>
<identifier>hdl:11022/0000-0001-3275-3</identifier>
<datestamp>2016-09-07T15:19:02Z</datestamp>
</header>
<metadata>
<ns3:dc>
<ns2:creator>fugifu</ns2:creator>
<ns2:date>2016-09-07T15:19:02Z</ns2:date>
<ns2:format>image/gif</ns2:format>
<ns2:identifier>http://repository.de.dariah.eu/dhcrud/11022/0000-0001-3275-3/metadata</ns2:identifier>
<ns2:identifier>http://repository.de.dariah.eu/dhcrud/11022/0000-0001-3275-3/data</ns2:identifier>
<ns2:identifier>hdl:11022/0000-0001-3275-3</ns2:identifier>
<ns2:relation>dariah:collection:11022/0000-0001-326F-B</ns2:relation>
<ns2:rights>fugifu</ns2:rights>
<ns2:title>GiantWasp.gif</ns2:title>
</ns3:dc>
</metadata>
</record>
<resumptionToken completeListSize="322" cursor="100" >cXVlcnlUaGVuRmV0Y2g7NTszMzpDNWx2YkdZd1N3YTFtbWpLYzRqeXVnOzM0OndFT2ZuOTJ4U1I2bUY4eFZRTDlyMlE7MzY6d0VPZm45MnhTUjZtRjh4VlFMOXIyUTszNzp3RU9mbjkyeFNSNm1GOHhWUUw5cjJROzM1OndFT2ZuOTJ4U1I2bUY4eFZRTDlyMlE7MDs=</resumptionToken>
</ListRecords>
</OAI-PMH>
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
Example Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:ns2="http://purl.org/dc/elements/1.1/"
xmlns:ns3="http://www.openarchives.org/OAI/2.0/oai_dc/">
<responseDate>2017-02-15T16:00:06Z</responseDate>
<request verb="ListIdentifiers" metadataPrefix="oai_dc">repository.de.dariah.eu</request>
<ListIdentifiers>
<header>
<identifier>hdl:11022/0000-0001-3279-F</identifier>
<datestamp>2016-09-07T15:19:12Z</datestamp>
</header>
<header>
<identifier>hdl:11022/0000-0001-327D-B</identifier>
<datestamp>2016-09-07T15:19:24Z</datestamp>
</header>
<header>
<identifier>hdl:11022/0000-0001-3275-3</identifier>
<datestamp>2016-09-07T15:19:02Z</datestamp>
</header>
<header>
<identifier>hdl:11022/0000-0001-3282-3</identifier>
<datestamp>2016-09-07T15:19:35Z</datestamp>
</header>
<header>
<identifier>hdl:11022/0000-0001-3270-8</identifier>
<datestamp>2016-09-07T15:18:50Z</datestamp>
</header>
<header>
<identifier>hdl:11022/0000-0001-3286-F</identifier>
<datestamp>2016-09-07T15:19:45Z</datestamp>
</header>
<header>
<identifier>hdl:11022/0000-0001-328A-B</identifier>
<datestamp>2016-09-07T15:19:56Z</datestamp>
</header>
<header>
<identifier>hdl:11022/0000-0001-3BAB-D</identifier>
<datestamp>2016-09-14T13:37:20Z</datestamp>
</header>
<resumptionToken completeListSize="322" cursor="100"
>cXVlcnlUaGVuRmV0Y2g7NTszNDpDNWx2YkdZd1N3YTFtbWpLYzRqeXVnOzM4OndFT2ZuOTJ4U1I2bUY4eFZRTDlyMlE7MzU6QzVsdmJHWXdTd2ExbW1qS2M0anl1ZzszNzpDNWx2YkdZd1N3YTFtbWpLYzRqeXVnOzM2OkM1bHZiR1l3U3dhMW1taktjNGp5dWc7MDs=</resumptionToken>
</ListIdentifiers>
</OAI-PMH>
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
Example Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:ns2="http://purl.org/dc/elements/1.1/"
xmlns:ns3="http://www.openarchives.org/OAI/2.0/oai_dc/">
<responseDate>2017-02-15T16:01:42Z</responseDate>
<request verb="ListMetadataFormats">repository.de.dariah.eu</request>
<ListMetadataFormats>
<metadataFormat>
<metadataPrefix>oai_dc</metadataPrefix>
<schema>http://www.openarchives.org/OAI/2.0/oai_dc.xsd</schema>
<metadataNamespace>http://www.openarchives.org/OAI/2.0/oai_dc/</metadataNamespace>
</metadataFormat>
</ListMetadataFormats>
</OAI-PMH>
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
Example Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:ns2="http://purl.org/dc/elements/1.1/"
xmlns:ns3="http://www.openarchives.org/OAI/2.0/oai_dc/">
<responseDate>2017-02-15T16:03:49Z</responseDate>
<request verb="ListSets" metadataPrefix="oai_dc">repository.de.dariah.eu</request>
<ListSets>
<set>
<setSpec>dariah:collection:11022/0000-0001-59CA-8</setSpec>
<setName>fus neue kollektion</setName>
</set>
<set>
<setSpec>dariah:collection:11022/0000-0001-B439-4</setSpec>
<setName>furglitestitest</setName>
</set>
<set>
<setSpec>dariah:collection:11022/0000-0001-B530-C</setSpec>
<setName>DARIAH-DE Repository – Prototype (M 4.3.2.1)</setName>
</set>
</ListSets>
</OAI-PMH>
Sources¶
See oaipmh_sources