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

<?xml version="1.0" encoding="UTF-8"?>
<OAI-PMH>
    <responseDate>2015-05-21T14:34:29Z</responseDate>
    <request verb="Identify">www.textgridrep.de</request>
    <Identify>
        <repositoryName>TextGrid-Repository</repositoryName>
        <baseURL>www.textgridrep.de</baseURL>
        <protocolVersion>2.0</protocolVersion>
        <adminEmail>textgrid-support.gwdg.de</adminEmail>
        <earliestDatestamp>2011-06-11T02:32:40Z</earliestDatestamp>
        <deletedRecord>no</deletedRecord>
        <granularity>YYYY-MM-DDThh:mm:ssZ</granularity>
    </Identify>
</OAI-PMH>

Error Response (Illegal Verb)

<?xml version="1.0" encoding="UTF-8"?>
<OAI-PMH>
    <responseDate>2015-10-29T10:40:22Z</responseDate>
    <request>www.textgridrep.de</request>
    <error code="badVerb">Illegal OAI-PMH verb</error>
</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:

http://textgridlab.org/1.0/tgoaipmh/oai?verb=GetRecord&identifier=textgrid:vqmw.0&metadataPrefix=oai_dc

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>2015-10-30T15:33:52Z</responseDate>
    <request verb="GetRecord" identifier="textgrid:vqn0.0"
        metadataPrefix="oai_dc">www.textgridrep.de</request>
    <GetRecord>
        <record>
            <header>
                <identifier>textgrid:vqn0.0</identifier>
                <datestamp>2012-02-05T02:01:23.833+01:00</datestamp>
            </header>
            <metadata>
                <ns3:dc>
                    <ns2:contributor>tvitt@textgrid.de</ns2:contributor>
                    <ns2:creator>Spyri, Johanna</ns2:creator>
                    <ns2:date>2012-02-05T01:01:22Z</ns2:date>
                    <ns2:date>2012-02-05T01:01:22Z</ns2:date>
                    <ns2:format>text/tg.edition+tg.aggregation+xml</ns2:format>
                    <ns2:identifier>textgrid:vqn0.0</ns2:identifier>
                    <ns2:identifier>hdl:11858/00-1734-0000-0005-1422-F</ns2:identifier>
                    <ns2:relation>TGPR-372fe6dc-57f2-6cd4-01b5-2c4bbefcfd3c</ns2:relation>
                    <ns2:relation>Heidi kann brauchen, was es gelernt
                        hat</ns2:relation>
                    <ns2:relation>textgrid:vqmx.0</ns2:relation>
                    <ns2:rights>http://creativecommons.org/licenses/by/3.0/de/legalcode</ns2:rights>
                    <ns2:source>Spyri, Johanna</ns2:source>
                    <ns2:source>Johanna Spyri: Heidi kann brauchen, was es
                        gelernt hat, Zürich: Diogenes, 1978.</ns2:source>
                    <ns2:source>Zürich</ns2:source>
                    <ns2:source>11</ns2:source>
                    <ns2:title>Heidi kann brauchen, was es gelernt
                        hat</ns2:title>
                    <ns2:type>prose</ns2:type>
                </ns3:dc>
            </metadata>
        </record>
    </GetRecord>
</OAI-PMH>

Example Error Response (URI is no content of TextGridRepository)

<?xml version="1.0" encoding="UTF-8"?>
<OAI-PMH>
    <responseDate>2015-10-29T10:43:17Z</responseDate>
    <request verb="GetRecord" identifier="textgrid:t.0"
        metadataPrefix="oai_dc">www.textgridrep.de</request>
    <error code="noRecordsMatch">The value of the identifier: textgrid:t.0
        is unknown or illegal in this repository</error>
</OAI-PMH>

Example Error Response (includes illegal arguments or is missing required arguments)

<?xml version="1.0" encoding="UTF-8"?>
<OAI-PMH>
    <responseDate>2015-10-29T10:44:37Z</responseDate>
    <request verb="GetRecord" identifier="textgrid:7t.0"
        >www.textgridrep.de</request>
    <error code="badArgument">The request includes illegal arguments or is
        missing required arguments: [metadataPrefix]</error>
</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:

http://textgridlab.org/1.0/tgoaipmh/oai?verb=ListRecords&metadataPrefix=oai_dc

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>2015-10-29T11:09:24Z</responseDate>
    <request verb="ListRecords" metadataPrefix="oai_dc"
        >www.textgridrep.de</request>
    <ListRecords>
        <record>
            <header>
                <identifier>textgrid:r49s.0</identifier>
                <datestamp>2012-01-28T19:54:02Z</datestamp>
            </header>
            <metadata>
                <ns3:dc>
                    <ns2:contributor>tvitt@textgrid.de</ns2:contributor>
                    <ns2:creator>Kuhn, Adalbert</ns2:creator>
                    <ns2:date>2012-01-28T19:54:02Z</ns2:date>
                    <ns2:format>text/tg.edition+tg.aggregation+xml</ns2:format>
                    <ns2:identifier>textgrid:r49s.0</ns2:identifier>
                    <ns2:identifier>hdl:11858/00-1734-0000-0003-BD44-0</ns2:identifier>
                    <ns2:relation>TGPR-372fe6dc-57f2-6cd4-01b5-2c4bbefcfd3c</ns2:relation>
                    <ns2:relation>25. St.-Hülpe bei Diepholz</ns2:relation>
                    <ns2:relation>textgrid:r49t.0</ns2:relation>
                    <ns2:rights>http://creativecommons.org/licenses/by/3.0/de/legalcode</ns2:rights>
                    <ns2:source>Kuhn, Adalbert</ns2:source>
                    <ns2:source>Adalbert Kuhn: Sagen, Gebräuche und Märchen
                        aus Westfalen und einigen andern, besonders den
                        angrenzenden Gegenden Norddeutschlands 1–2. Band 1,
                        Leipzig: Brockhaus, 1859.</ns2:source>
                    <ns2:source>Leipzig</ns2:source>
                    <ns2:source>20</ns2:source>
                    <ns2:title>25. St.-Hülpe bei Diepholz</ns2:title>
                    <ns2:type>other</ns2:type>
                </ns3:dc>
            </metadata>
        </record>
        <record>
            <header>
                <identifier>textgrid:vs2t.0</identifier>
                <datestamp>2012-02-05T03:08:12Z</datestamp>
            </header>
            <metadata>
                <ns3:dc>
                    <ns2:contributor>tvitt@textgrid.de</ns2:contributor>
                    <ns2:creator>Stifter, Adalbert</ns2:creator>
                    <ns2:date>2012-02-05T03:08:12Z</ns2:date>
                    <ns2:format>text/tg.edition+tg.aggregation+xml</ns2:format>
                    <ns2:identifier>textgrid:vs2t.0</ns2:identifier>
                    <ns2:identifier>hdl:11858/00-1734-0000-0005-18E0-5</ns2:identifier>
                    <ns2:relation>TGPR-372fe6dc-57f2-6cd4-01b5-2c4bbefcfd3c</ns2:relation>
                    <ns2:relation>Nachkommenschaften</ns2:relation>
                    <ns2:relation>textgrid:vs2s.0</ns2:relation>
                    <ns2:rights>http://creativecommons.org/licenses/by/3.0/de/legalcode</ns2:rights>
                    <ns2:source>Stifter, Adalbert</ns2:source>
                    <ns2:source>Adelbert Stifter: Gesammelte Werke in sechs
                        Bänden, [herausgegeben von Max Stefl,] Band 3,
                        6.–10. Tausend der Gesamtausgabe, Wiesbaden: Insel,
                        1959.</ns2:source>
                    <ns2:source>Wiesbaden</ns2:source>
                    <ns2:source>565</ns2:source>
                    <ns2:title>Nachkommenschaften</ns2:title>
                    <ns2:type>prose</ns2:type>
                </ns3:dc>
            </metadata>
        </record>
        <record>
            <header>
                <identifier>textgrid:v73g.0</identifier>
                <datestamp>2012-02-04T08:33:36Z</datestamp>
            </header>
            <metadata>
                <ns3:dc>
                    <ns2:contributor>tvitt@textgrid.de</ns2:contributor>
                    <ns2:creator>Schönwerth, Franz</ns2:creator>
                    <ns2:date>2012-02-04T08:33:36Z</ns2:date>
                    <ns2:format>text/tg.edition+tg.aggregation+xml</ns2:format>
                    <ns2:identifier>textgrid:v73g.0</ns2:identifier>
                    <ns2:identifier>hdl:11858/00-1734-0000-0004-E464-5</ns2:identifier>
                    <ns2:relation>TGPR-372fe6dc-57f2-6cd4-01b5-2c4bbefcfd3c</ns2:relation>
                    <ns2:relation>2. Das Ochsenkopf</ns2:relation>
                    <ns2:relation>textgrid:v73h.0</ns2:relation>
                    <ns2:rights>http://creativecommons.org/licenses/by/3.0/de/legalcode</ns2:rights>
                    <ns2:source>Schönwerth, Franz</ns2:source>
                    <ns2:source>Franz Schönwerth: Aus der Oberpfalz. Sitten
                        und Sagen 1–3, Band 2, Augsburg: Rieger,
                        1857/58/59.</ns2:source>
                    <ns2:source>Augsburg</ns2:source>
                    <ns2:source>238</ns2:source>
                    <ns2:title>2. Das Ochsenkopf</ns2:title>
                    <ns2:type>other</ns2:type>
                </ns3:dc>
            </metadata>
        </record>
    </ListRecords>
</OAI-PMH>

Example Error 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>2015-10-29T11:12:50Z</responseDate>
    <request verb="ListRecords" metadataPrefix="oai_d"
        >www.textgridrep.de</request>
    <error code="cannotDisseminateFormat"> The value of the metadataPrefix:
        oai_d is not supported by the item identified by the value of: null
    </error>
</OAI-PMH>

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

<?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>2015-10-30T15:47:32Z</responseDate>
    <request verb="ListIdentifiers" metadataPrefix="oai_dc"
        >www.textgridrep.de</request>
    <ListIdentifiers>
        <header>
            <identifier>textgrid:r49s.0</identifier>
        </header>
        <header>
            <identifier>textgrid:vs2t.0</identifier>
        </header>
        <header>
            <identifier>textgrid:v73g.0</identifier>
        </header>
        <header>
            <identifier>textgrid:rd5n.0</identifier>
        </header>
        <header>
            <identifier>textgrid:qmgt.0</identifier>
        </header>
        <header>
            <identifier>textgrid:10593.0</identifier>
        </header>
        <header>
            <identifier>textgrid:mwnv.0</identifier>
        </header>
        <header>
            <identifier>textgrid:v0xr.0</identifier>
        </header>
        …
        …
        …
    </ListIdentifiers>
</OAI-PMH>

Example Error 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>2015-10-29T11:22:46Z</responseDate>
    <request verb="ListIdentifiers" metadataPrefix="oai_dc" from="2017"
        >www.textgridrep.de</request>
    <error code="noRecordsMatch"> The combination of the values 2017 and
        null results in an empty list </error>
</OAI-PMH>

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<OAI-PMH>
    <responseDate>2015-05-21T14:13:38Z</responseDate>
    <request verb="ListMetadataFormats">www.textgridrep.de</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

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

<?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>2015-10-29T11:27:04Z</responseDate>
    <request verb="ListSets">www.textgridrep.de</request>
    <ListSets>
        <set>
            <setSpec>textgrid:r49s.0</setSpec>
            <setName/>
        </set>
        <set>
            <setSpec>textgrid:vs2t.0</setSpec>
            <setName/>
        </set>
        <set>
            <setSpec>textgrid:v73g.0</setSpec>
            <setName/>
        </set>
    </ListSets>
</OAI-PMH>

Example Error Response

<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>2015-10-29T11:30:27Z</responseDate>
    <request>www.textgridrep.de</request>
    <error code="badVerb">Illegal OAI-PMH verb</error>
</OAI-PMH>

Version, Cmstat, and BuildInfo

Version, connection manager status and build info can be adressed using: