A PFD version of this DH-oaipmh Service Documentation you can find HERE.
DH-oaipmh Service¶
The DARIAH-DE OAI-PMH Service is the service to harvest all metadata from the collections stored in the DARIAH-DE Repository. So the Generic Search can index all the data that is entered into the Collection registry.
API Documentation¶
#VERSION¶
To check the current productive OAI-PMH version simply try:
and you get the currently deployed version of the DARIAH-DE OAI-PMH Service.
#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 the listRecords request is given |
ListMetadataFormats | Shows the metadata formats supported by the repository or all metadata formats 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
<?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-12-05T16:54:46Z</responseDate>
<request verb="Identify">repository.de.dariah.eu</request>
<Identify>
<repositoryName>DARIAH-DE Repository</repositoryName>
<baseURL>http://repository.de.dariah.eu/1.0</baseURL>
<protocolVersion>2.0</protocolVersion>
<adminEmail>support@de.dariah.eu</adminEmail>
<earliestDatestamp>2011-06-11T02:32:40Z</earliestDatestamp>
<deletedRecord>no</deletedRecord>
<granularity>YYYY-MM-DDThh:mm:ssZ</granularity>
</Identify>
</OAI-PMH>
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
<?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-12-05T16:57:34Z</responseDate>
<request verb="GetRecord" identifier="21.11113/0000-000B-C8EF-7" metadataPrefix="oai_dc"
>repository.de.dariah.eu</request>
<GetRecord>
<record>
<header>
<identifier>hdl:21.11113/0000-000B-C8EF-7</identifier>
<datestamp>2017-12-04T18:25:31Z</datestamp>
</header>
<metadata>
<ns3:dc>
<ns2:creator>DARIAH-DE</ns2:creator>
<ns2:date>2017-12-04T18:25:31Z</ns2:date>
<ns2:description>The collection containing the terms of use for the DARIAH-DE
Repository.</ns2:description>
<ns2:format>text/vnd.dariah.dhrep.collection+turtle</ns2:format>
<ns2:identifier>doi:10.20375/0000-000B-C8EF-7</ns2:identifier>
<ns2:identifier>hdl:21.11113/0000-000B-C8EF-7</ns2:identifier>
<ns2:rights>CC0</ns2:rights>
<ns2:title>DARIAH-DE Repository – Terms of Use</ns2:title>
</ns3:dc>
</metadata>
</record>
</GetRecord>
</OAI-PMH>
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-12-05T16:59:04Z</responseDate>
<request verb="ListRecords" metadataPrefix="oai_dc" set="21.11113/"
>repository.de.dariah.eu</request>
<ListRecords>
<record>
<header>
<identifier>hdl:21.11113/0000-000B-C8FE-6</identifier>
<datestamp>2017-12-05T12:52:29Z</datestamp>
<setSpec>21.11113/</setSpec>
</header>
<metadata>
<ns3:dc>
<ns2:creator>Mache, Beata</ns2:creator>
<ns2:date>2017-12-05T12:52:29Z</ns2:date>
<ns2:format>text/xml</ns2:format>
<ns2:identifier>doi:10.20375/0000-000B-C8FE-6</ns2:identifier>
<ns2:identifier>hdl:21.11113/0000-000B-C8FE-6</ns2:identifier>
<ns2:relation>hdl:21.11113/0000-000B-C8F2-2</ns2:relation>
<ns2:rights>CC BY</ns2:rights>
<ns2:title>Universal-Kirchenzeitung-XML_015.xml</ns2:title>
</ns3:dc>
</metadata>
</record>
<record>
<header>
<identifier>hdl:21.11113/0000-000B-C906-C</identifier>
<datestamp>2017-12-05T12:52:37Z</datestamp>
<setSpec>21.11113/</setSpec>
</header>
<metadata>
<ns3:dc>
<ns2:creator>Mache, Beata</ns2:creator>
<ns2:date>2017-12-05T12:52:37Z</ns2:date>
<ns2:format>text/xml</ns2:format>
<ns2:identifier>doi:10.20375/0000-000B-C906-C</ns2:identifier>
<ns2:identifier>hdl:21.11113/0000-000B-C906-C</ns2:identifier>
<ns2:relation>hdl:21.11113/0000-000B-C8F2-2</ns2:relation>
<ns2:rights>CC BY</ns2:rights>
<ns2:title>Universal-Kirchenzeitung-XML_033.xml</ns2:title>
</ns3:dc>
</metadata>
</record>
...
<record>
<header>
<identifier>hdl:21.11113/0000-000B-C988-9</identifier>
<datestamp>2017-12-05T12:54:51Z</datestamp>
<setSpec>21.11113/</setSpec>
</header>
<metadata>
<ns3:dc>
<ns2:creator>Honinghaus, Julius Vinzent</ns2:creator>
<ns2:date>2017-12-05T12:54:51Z</ns2:date>
<ns2:format>PDF</ns2:format>
<ns2:identifier>hdl:21.11113/0000-000B-C988-9</ns2:identifier>
<ns2:identifier>doi:10.20375/0000-000B-C988-9</ns2:identifier>
<ns2:language>de</ns2:language>
<ns2:relation>hdl:21.11113/0000-000B-C8F2-2</ns2:relation>
<ns2:rights>CC 0</ns2:rights>
<ns2:title>Universal-Kirchenzeitung-Faksimile_041.pdf</ns2:title>
</ns3:dc>
</metadata>
</record>
<resumptionToken completeListSize="343" cursor="100"
>cXVlcnlUaGVuRmV0Y2g7NTsxMTE3OkZ1cl9ubFphUkh1MkFLVTRiTXZzZVE7NzQ1OkJZV01aOWlYVHhtdFRwd3lDWXpTalE7MTExOTpGdXJfbmxaYVJIdTJBS1U0Yk12c2VROzc0NjpCWVdNWjlpWFR4bXRUcHd5Q1l6U2pROzExMTg6RnVyX25sWmFSSHUyQUtVNGJNdnNlUTswOw==</resumptionToken>
</ListRecords>
</OAI-PMH>
ListIdentifiers Request¶
Parameter | Type | Description | Required |
---|---|---|---|
verb=ListIdentifiers | String | Verb for the ListIdentifiers 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-12-05T17:00:27Z</responseDate>
<request verb="ListIdentifiers" metadataPrefix="oai_dc">repository.de.dariah.eu</request>
<ListIdentifiers>
<header>
<identifier>hdl:21.11113/0000-000B-C8F0-4</identifier>
<datestamp>2017-12-04T18:25:31Z</datestamp>
</header>
<header>
<identifier>hdl:21.11113/0000-000B-C8FC-8</identifier>
<datestamp>2017-12-05T12:52:27Z</datestamp>
</header>
<header>
<identifier>hdl:21.11113/0000-000B-C904-E</identifier>
<datestamp>2017-12-05T12:52:35Z</datestamp>
</header>
<header>
<identifier>hdl:21.11113/0000-000B-C90C-6</identifier>
<datestamp>2017-12-05T12:52:43Z</datestamp>
</header>
<header>
<identifier>hdl:21.11113/0000-000B-C914-C</identifier>
<datestamp>2017-12-05T12:52:51Z</datestamp>
</header>
...
<header>
<identifier>hdl:21.11113/0000-000B-C946-4</identifier>
<datestamp>2017-12-05T12:53:43Z</datestamp>
</header>
<header>
<identifier>hdl:21.11113/0000-000B-C94E-C</identifier>
<datestamp>2017-12-05T12:53:50Z</datestamp>
</header>
<resumptionToken completeListSize="348" cursor="100"
>cXVlcnlUaGVuRmV0Y2g7NTsxMTIwOkZ1cl9ubFphUkh1MkFLVTRiTXZzZVE7NzQ3OkJZV01aOWlYVHhtdFRwd3lDWXpTalE7MTEyMjpGdXJfbmxaYVJIdTJBS1U0Yk12c2VROzc0ODpCWVdNWjlpWFR4bXRUcHd5Q1l6U2pROzExMjE6RnVyX25sWmFSSHUyQUtVNGJNdnNlUTswOw==</resumptionToken>
</ListIdentifiers>
</OAI-PMH>
ListMetadataformats Request¶
Parameter | Type | Description | Required |
---|---|---|---|
verb=ListMetadataFormats | String | Verb for the listIdentifiers 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-12-05T17:01:23Z</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-12-05T17:02:17Z</responseDate>
<request verb="ListSets">repository.de.dariah.eu</request>
<ListSets>
<set>
<setSpec>hdl:21.11113/0000-000B-CA34-7</setSpec>
<setName>Universal-Kirchenzeitung - KML-File</setName>
</set>
<set>
<setSpec>hdl:21.11113/0000-000B-C8F4-0</setSpec>
<setName>Universal-Kirchenzeitung - XML</setName>
</set>
<set>
<setSpec>hdl:21.11113/0000-000B-C8F2-2</setSpec>
<setName>Unparteiische Universal-Kirchenzeitung für die Geistlichkeit und die gebildete
Weltklasse des protestantischen, katholischen und israelitischen
Deutschlands</setName>
</set>
<set>
<setSpec>hdl:21.11113/0000-000B-CA3E-D</setSpec>
<setName>Universal-Kirchenzeitung - Register</setName>
</set>
<set>
<setSpec>hdl:21.11113/0000-000B-C95E-A</setSpec>
<setName>Universal-Kirchenzeitung - Faksimile</setName>
</set>
<set>
<setSpec>hdl:21.11113/0000-000B-C9C8-1</setSpec>
<setName>Universal-Kirchenzeitung - Volltext</setName>
</set>
<set>
<setSpec>hdl:21.11113/0000-000B-C8EF-7</setSpec>
<setName>DARIAH-DE Repository – Terms of Use</setName>
</set>
</ListSets>
</OAI-PMH>
Sources¶
See oaipmh_sources