From f26cdcfd05c7c70f3e914d893d94c094692f8365 Mon Sep 17 00:00:00 2001 From: "Stefan E. Funk" <funk@sub.uni-goettingen.de> Date: Wed, 15 Feb 2017 17:17:31 +0100 Subject: [PATCH] more docs... --- docs_dhrep/api/GetRecordResponse.xml | 25 --- docs_dhrep/api/IdentifyResponse.xml | 15 -- docs_dhrep/api/ListIdentifiersResponse.xml | 42 ---- .../api/ListMetadataFormatsResponse.xml | 13 -- docs_dhrep/api/ListRecordsResponse.xml | 66 ------ docs_dhrep/api/ListSetsResponse.xml | 20 -- docs_dhrep/api/oai.rst | 174 ---------------- docs_dhrep/api/oai.rst~ | 194 ------------------ docs_dhrep/index.rst | 176 +++++++++++++++- 9 files changed, 173 insertions(+), 552 deletions(-) delete mode 100644 docs_dhrep/api/GetRecordResponse.xml delete mode 100644 docs_dhrep/api/IdentifyResponse.xml delete mode 100644 docs_dhrep/api/ListIdentifiersResponse.xml delete mode 100644 docs_dhrep/api/ListMetadataFormatsResponse.xml delete mode 100644 docs_dhrep/api/ListRecordsResponse.xml delete mode 100644 docs_dhrep/api/ListSetsResponse.xml delete mode 100644 docs_dhrep/api/oai.rst delete mode 100644 docs_dhrep/api/oai.rst~ diff --git a/docs_dhrep/api/GetRecordResponse.xml b/docs_dhrep/api/GetRecordResponse.xml deleted file mode 100644 index 0917ae2d..00000000 --- a/docs_dhrep/api/GetRecordResponse.xml +++ /dev/null @@ -1,25 +0,0 @@ -<?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:52:47Z</responseDate> - <request verb="GetRecord" identifier="11022/0000-0001-B739-1" metadataPrefix="oai_dc" - >repository.de.dariah.eu</request> - <GetRecord> - <record> - <header> - <identifier>hdl:11022/0000-0001-B739-1</identifier> - <datestamp>2017-02-10T14:50:20Z</datestamp> - </header> - <metadata> - <ns3:dc> - <ns2:creator>fu</ns2:creator> - <ns2:date>2017-02-10T14:50:20Z</ns2:date> - <ns2:format>text/tg.collection+tg.aggregation+xml</ns2:format> - <ns2:identifier>http://repository.de.dariah.eu/dhcrud/11022/0000-0001-B739-1/index</ns2:identifier> - <ns2:rights>free</ns2:rights> - <ns2:title>Argliwargli</ns2:title> - </ns3:dc> - </metadata> - </record> - </GetRecord> -</OAI-PMH> diff --git a/docs_dhrep/api/IdentifyResponse.xml b/docs_dhrep/api/IdentifyResponse.xml deleted file mode 100644 index e2d77f90..00000000 --- a/docs_dhrep/api/IdentifyResponse.xml +++ /dev/null @@ -1,15 +0,0 @@ -<?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:47:16Z</responseDate> - <request verb="Identify">repository.de.dariah.eu</request> - <Identify> - <repositoryName>DARIAH-DE Repository</repositoryName> - <baseURL>http://repository.de.dariah.eu</baseURL> - <protocolVersion>2.0</protocolVersion> - <adminEmail>funk@sub.uni-goettingen.de</adminEmail> - <earliestDatestamp>2011-06-11T02:32:40Z</earliestDatestamp> - <deletedRecord>no</deletedRecord> - <granularity>YYYY-MM-DDThh:mm:ssZ</granularity> - </Identify> -</OAI-PMH> diff --git a/docs_dhrep/api/ListIdentifiersResponse.xml b/docs_dhrep/api/ListIdentifiersResponse.xml deleted file mode 100644 index 16dbf64c..00000000 --- a/docs_dhrep/api/ListIdentifiersResponse.xml +++ /dev/null @@ -1,42 +0,0 @@ -<?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> diff --git a/docs_dhrep/api/ListMetadataFormatsResponse.xml b/docs_dhrep/api/ListMetadataFormatsResponse.xml deleted file mode 100644 index 6d8008f9..00000000 --- a/docs_dhrep/api/ListMetadataFormatsResponse.xml +++ /dev/null @@ -1,13 +0,0 @@ -<?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> diff --git a/docs_dhrep/api/ListRecordsResponse.xml b/docs_dhrep/api/ListRecordsResponse.xml deleted file mode 100644 index fca23d93..00000000 --- a/docs_dhrep/api/ListRecordsResponse.xml +++ /dev/null @@ -1,66 +0,0 @@ -<?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> diff --git a/docs_dhrep/api/ListSetsResponse.xml b/docs_dhrep/api/ListSetsResponse.xml deleted file mode 100644 index f6ce115e..00000000 --- a/docs_dhrep/api/ListSetsResponse.xml +++ /dev/null @@ -1,20 +0,0 @@ -<?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> diff --git a/docs_dhrep/api/oai.rst b/docs_dhrep/api/oai.rst deleted file mode 100644 index 381e56b4..00000000 --- a/docs_dhrep/api/oai.rst +++ /dev/null @@ -1,174 +0,0 @@ -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** - -.. literalinclude:: IdentifyResponse.xml - :language: xml - - -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** - -.. literalinclude:: GetRecordResponse.xml - :language: xml - - -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** - -.. literalinclude:: ListRecordsResponse.xml - :language: xml - - -ListIdentifiers ------------------ -==================== ======= ========================================================= ========== -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** - -.. literalinclude:: ListIdentifiersResponse.xml - :language: xml - - -ListMetadataformats -------------------- -======================== ======= ========================================================= ========== -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** - -.. literalinclude:: ListMetadataFormatsResponse.xml - :language: xml - - -ListSets -------------------- -======================== ======= ========================================================= ========== -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** - -.. literalinclude:: ListSetsResponse.xml - :language: xml - - -Version -======= - -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 diff --git a/docs_dhrep/api/oai.rst~ b/docs_dhrep/api/oai.rst~ deleted file mode 100644 index 88d0b79b..00000000 --- a/docs_dhrep/api/oai.rst~ +++ /dev/null @@ -1,194 +0,0 @@ -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 metadatformats 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**:: - - http://textgridlab.org/1.0/tgoaipmh/oai?verb=Identify - -**Example Response** - -.. literalinclude:: IdentifyResponse.xml - :language: xml - - -**Error Response (Illegal Verb)** - -.. literalinclude:: IdentifyError.xml - :language: xml - - -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**:: - - http://textgridlab.org/1.0/tgoaipmh/oai?verb=GetRecord&identifier=textgrid:vqmw.0&metadataPrefix=oai_dc - -**Example Response** - -.. literalinclude:: GetRecordResponse.xml - :language: xml - - -**Example Error Response (URI is no content of TextGridRepository)** - -.. literalinclude:: GetRecordError1.xml - :language: xml - - -**Example Error Response (includes illegal arguments or is missing required arguments)** - -.. literalinclude:: GetRecordError2.xml - :language: xml - - -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**:: - - http://textgridlab.org/1.0/tgoaipmh/oai?verb=ListRecords&metadataPrefix=oai_dc - -**Example Response** - -.. literalinclude:: ListRecordsResponse.xml - :language: xml - - -**Example Error Response** - -.. literalinclude:: ListRecordsError.xml - :language: xml - - -ListIdentifiers ------------------ -==================== ======= ========================================================= ========== -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**:: - - http://textgridlab.org/1.0/tgoaipmh/oai?verb=ListIdentifiers&metadataPrefix=oai_dc - -**Example Response** - -.. literalinclude:: ListIdentifiers.xml - :language: xml - -**Example Error Response** - -.. literalinclude:: ListIdentifiersError.xml - :language: xml - - -ListMetadataformats -------------------- -======================== ======= ========================================================= ========== -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**:: - - http://textgridlab.org/1.0/tgoaipmh/oai?verb=ListMetadataFormats - -**Example Response** - -.. literalinclude:: ListMetadataFormats.xml - :language: xml - - -ListSets -------------------- -======================== ======= ========================================================= ========== -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**:: - - http://textgridlab.org/1.0/tgoaipmh/oai?verb=ListSets - -**Example Response** - -.. literalinclude:: ListSets.xml - :language: xml - -**Example Error Response** - -.. literalinclude:: ListSetsError.xml - :language: xml diff --git a/docs_dhrep/index.rst b/docs_dhrep/index.rst index cfe2675f..8df87feb 100644 --- a/docs_dhrep/index.rst +++ b/docs_dhrep/index.rst @@ -12,10 +12,180 @@ OAI-PMH is the service to harvest all metadata from the collections stored in th API Documentation ----------------- -.. toctree:: - :maxdepth: 2 +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: - api/oai.rst +==================== ==================================================================== +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** + +.. literalinclude:: IdentifyResponse.xml + :language: xml + + +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** + +.. literalinclude:: GetRecordResponse.xml + :language: xml + + +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** + +.. literalinclude:: ListRecordsResponse.xml + :language: xml + + +ListIdentifiers +----------------- +==================== ======= ========================================================= ========== +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** + +.. literalinclude:: ListIdentifiersResponse.xml + :language: xml + + +ListMetadataformats +------------------- +======================== ======= ========================================================= ========== +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** + +.. literalinclude:: ListMetadataFormatsResponse.xml + :language: xml + + +ListSets +------------------- +======================== ======= ========================================================= ========== +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** + +.. literalinclude:: ListSetsResponse.xml + :language: xml + + +Version +======= + +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 -- GitLab