diff --git a/docs/api/GetRecordError1.xml b/docs/api/GetRecordError1.xml new file mode 100644 index 0000000000000000000000000000000000000000..43f15e4e5d8c551c48238c5f9bdf2fce94154ec9 --- /dev/null +++ b/docs/api/GetRecordError1.xml @@ -0,0 +1,8 @@ +<?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> diff --git a/docs/api/GetRecordError2.xml b/docs/api/GetRecordError2.xml new file mode 100644 index 0000000000000000000000000000000000000000..c1484785dd6c035eeb2a56bb06afa9977426b3d0 --- /dev/null +++ b/docs/api/GetRecordError2.xml @@ -0,0 +1,8 @@ +<?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> diff --git a/docs/api/GetRecordResponse.xml b/docs/api/GetRecordResponse.xml new file mode 100644 index 0000000000000000000000000000000000000000..177b9ee50731075ac009e83aac03faad06821957 --- /dev/null +++ b/docs/api/GetRecordResponse.xml @@ -0,0 +1,40 @@ +<?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> diff --git a/docs/api/IdentifyError.xml b/docs/api/IdentifyError.xml new file mode 100644 index 0000000000000000000000000000000000000000..63c1e011220c182820aa9a8434649805ff621318 --- /dev/null +++ b/docs/api/IdentifyError.xml @@ -0,0 +1,6 @@ +<?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> diff --git a/docs/api/IdentifyResponse.xml b/docs/api/IdentifyResponse.xml new file mode 100644 index 0000000000000000000000000000000000000000..c0fd034513c28be8c66614b7f18e1e8dc6938033 --- /dev/null +++ b/docs/api/IdentifyResponse.xml @@ -0,0 +1,14 @@ +<?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> diff --git a/docs/api/ListIdentifiers.xml b/docs/api/ListIdentifiers.xml new file mode 100644 index 0000000000000000000000000000000000000000..dbf3bd6e7f1417aa7fb48cefdd3bd0ca86eaf3ca --- /dev/null +++ b/docs/api/ListIdentifiers.xml @@ -0,0 +1,37 @@ +<?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> diff --git a/docs/api/ListIdentifiersError.xml b/docs/api/ListIdentifiersError.xml new file mode 100644 index 0000000000000000000000000000000000000000..fdec838df429d6d4bcd0fab646d4c57a91aa25ff --- /dev/null +++ b/docs/api/ListIdentifiersError.xml @@ -0,0 +1,10 @@ +<?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> diff --git a/docs/api/ListMetadataFormats.xml b/docs/api/ListMetadataFormats.xml new file mode 100644 index 0000000000000000000000000000000000000000..ed74e7dccd9fe4ce876abe23006652cb0ce2f84f --- /dev/null +++ b/docs/api/ListMetadataFormats.xml @@ -0,0 +1,12 @@ +<?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> diff --git a/docs/api/ListRecordsError.xml b/docs/api/ListRecordsError.xml new file mode 100644 index 0000000000000000000000000000000000000000..104c9fa1897a803e0d09c45fdbb644be8f78e0eb --- /dev/null +++ b/docs/api/ListRecordsError.xml @@ -0,0 +1,11 @@ +<?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> diff --git a/docs/api/ListRecordsResponse.xml b/docs/api/ListRecordsResponse.xml new file mode 100644 index 0000000000000000000000000000000000000000..b1d49d4fcb06f61fccfeadfb5dd6fc978911e56f --- /dev/null +++ b/docs/api/ListRecordsResponse.xml @@ -0,0 +1,96 @@ +<?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> diff --git a/docs/api/ListSets.xml b/docs/api/ListSets.xml new file mode 100644 index 0000000000000000000000000000000000000000..f0707f08d3f31e6e0a516a3b5ee04771fc796240 --- /dev/null +++ b/docs/api/ListSets.xml @@ -0,0 +1,21 @@ +<?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> diff --git a/docs/api/ListSetsError.xml b/docs/api/ListSetsError.xml new file mode 100644 index 0000000000000000000000000000000000000000..c5f0bffe9c4015e01a6fe4ed0ebf42cc99dd81fd --- /dev/null +++ b/docs/api/ListSetsError.xml @@ -0,0 +1,7 @@ +<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> diff --git a/docs/api/oai.rst b/docs/api/oai.rst index bc378244ea39a8cbd27c998dc3589333a7432903..88d0b79b5028baf3548ef81252b96d565dcc79d0 100644 --- a/docs/api/oai.rst +++ b/docs/api/oai.rst @@ -1,381 +1,194 @@ 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: -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 -resumptionToken Fetching last responses in smaller parts (not yet implemented in textgrid) -==================== ======================================================================================================================= +==================== ==================================================================== +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 -========================== ======= ====================================================================== ========== +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. + Objects belonging to a project, filter objects which are in an aggregation in same project. -**Example request**:: +**Example Request**:: http://textgridlab.org/1.0/tgoaipmh/oai?verb=Identify -**Example Response**:: +**Example Response** - <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> +.. literalinclude:: IdentifyResponse.xml + :language: xml -**Error Response (Illegal Verb) **:: +**Error Response (Illegal Verb)** - <OAI-PMH> - <responseDate>2015-10-29T10:40:22Z</responseDate> - <request>www.textgridrep.de</request> - <error code="badVerb">Illegal OAI-PMH verb</error> - </OAI-PMH> +.. literalinclude:: IdentifyError.xml + :language: xml + +GetRecord Request ----------------- -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 +=============== ======= ========================================================= ========== -========================== ======= ====================================================================== ========== -Parameter Type Description Required -========================== ======= ====================================================================== ========== -verb=getRecord String verb for the getRecord request yes -identifier URI identifier for the item inside the repository yes -metadataPrefix Stirng 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. -**Response** +**Example Request**:: - objects belonging to a project, filter objects which are in an aggregation in same project. + http://textgridlab.org/1.0/tgoaipmh/oai?verb=GetRecord&identifier=textgrid:vqmw.0&metadataPrefix=oai_dc -**Example request**:: +**Example Response** - http://textgridlab.org/1.0/tgoaipmh/oai?verb=GetRecord&identifier=textgrid:7t.0&metadataPrefix=oai_dc - -**Example Response**:: - - <OAI-PMH> - <responseDate>2015-05-21T12:25:43Z</responseDate> - <request verb="GetRecord" identifier="textgrid:7t.0" metadataPrefix="oai_dc">www.textgridrep.de</request> - <GetRecord> - <record> - <header> - <identifier>textgrid:7t.0</identifier> - <datestamp>2015-01-12T12:54:44.687+01:00</datestamp> - </header> - <metadata> - <ns3:dc> - <ns2:contributor>michael.leuk@textgrid.de</ns2:contributor> - <ns2:date>2015-01-12T11:55:18Z</ns2:date> - <ns2:format>text/tg.edition+tg.aggregation+xml</ns2:format> - <ns2:identifier>textgrid:7t.0</ns2:identifier> - <ns2:identifier>hdl:b068ff71-807e-45fb-b5d1-d618ffeec722</ns2:identifier> - <ns2:relation>TGPR-8741f26c-85e9-be58-68d8-54b3b5d26ded</ns2:relation> - <ns2:relation>werk-001</ns2:relation> - <ns2:relation>textgrid:7v.0</ns2:relation> - <ns2:title>Edition-001</ns2:title> - <ns2:type>drama</ns2:type> - </ns3:dc> - </metadata> - </record> - </GetRecord> - </OAI-PMH> - - -**Example Error Response (URI is no content of TextGridRepository)**:: - - <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)**:: - - <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> +.. 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 -========================== ======= ====================================================================== ========== +**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. + Objects belonging to a project, filter objects which are in an aggregation in same project. -**Example request**:: +**Example Request**:: http://textgridlab.org/1.0/tgoaipmh/oai?verb=ListRecords&metadataPrefix=oai_dc +**Example Response** -**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**:: - - <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> +.. literalinclude:: ListRecordsResponse.xml + :language: xml ------------------ -listIdentifiers ------------------ +**Example Error Response** -========================== ======= ====================================================================== ========== -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 -========================== ======= ====================================================================== ========== +.. 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. + Objects belonging to a project, filter objects which are in an aggregation in same project. -**Example request**:: +**Example Request**:: - http://textgridlab.org/1.0/tgoaipmh/oai?verb=GetRecord&identifier=textgrid:7t.0&metadataPrefix=oai_dc + http://textgridlab.org/1.0/tgoaipmh/oai?verb=ListIdentifiers&metadataPrefix=oai_dc +**Example Response** -**Example Error Response**:: +.. literalinclude:: ListIdentifiers.xml + :language: xml - <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> +**Example Error Response** +.. literalinclude:: ListIdentifiersError.xml + :language: xml +ListMetadataformats ------------------- -listMetadataformats -------------------- - -========================== ======= ====================================================================== ========== -Parameter Type Description Required -========================== ======= ====================================================================== ========== -verb=listMetadataFormats String verb for the listdentifiers request yes -identifier URI identifier of the requested item no -========================== ======= ====================================================================== ========== - +======================== ======= ========================================================= ========== +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. + Objects belonging to a project, filter objects which are in an aggregation in same project. -**Example request**:: +**Example Request**:: http://textgridlab.org/1.0/tgoaipmh/oai?verb=ListMetadataFormats -**Example Response**:: - - <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> +**Example Response** +.. literalinclude:: ListMetadataFormats.xml + :language: xml - -------------------- -listSets +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 -========================== ======= ====================================================================== ========== - +======================== ======= ========================================================= ========== +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. + 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**:: - - <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> +**Example Response** + +.. literalinclude:: ListSets.xml + :language: xml + +**Example Error Response** +.. literalinclude:: ListSetsError.xml + :language: xml