CINXE.COM

BASE OAI Interface 3.2 documentation

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>BASE OAI Interface 3.2 documentation</title> <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"/> <link rel="stylesheet" href="_static/rtd.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> <script type="text/javascript" src="_static/language_data.js"></script> <script type="text/javascript" src="_static/searchtools.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> </head><body> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="nav-item nav-item-0"><a href="index.html#document-index">BASE OAI Interface 3.2 documentation</a> &#187;</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <div class="section" id="base-oai-interface"> <h1>BASE OAI Interface<a class="headerlink" href="#base-oai-interface" title="Permalink to this headline">¶</a></h1> <div class="toctree-wrapper compound"> <span id="document-intro"></span><div class="section" id="introduction"> <h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2> <p>This documentation describes the <a class="reference external" href="http://www.openarchives.org/OAI/openarchivesprotocol.html">OAI-PMH</a> interface of <a class="reference external" href="http://base-search.net">Bielefeld Academic Search Engine (BASE)</a>. BASE is an OAI search service that currently includes the contents of more than 3,000 document servers worldwide.</p> <div class="section" id="pdf-download"> <h3>PDF Download<a class="headerlink" href="#pdf-download" title="Permalink to this headline">¶</a></h3> <p>Download this documentation as printable <a class="reference external" href="BASE_OAI_Interface.pdf">PDF document</a>.</p> </div> <div class="section" id="what-is-it-for"> <h3>What is it for?<a class="headerlink" href="#what-is-it-for" title="Permalink to this headline">¶</a></h3> <p>This API is especially suitable for clients that would like to get <em>subsets</em> of the BASE data. For instance, it can be used by <em>subject portals</em> to integrate subject-specific publication metadata from BASE into their indexes.</p> </div> <div class="section" id="alternatives"> <h3>Alternatives<a class="headerlink" href="#alternatives" title="Permalink to this headline">¶</a></h3> <ul class="simple"> <li>If you would like to embed <em>search results</em> from BASE directly in your infrastructure, please consider using the <a class="reference external" href="http://www.base-search.net/about/download/base_interface.pdf">BASE search API</a> instead.</li> <li>If you need a <em>complete dump</em> of the BASE data for your non-commercial project, please <a class="reference external" href="http://www.base-search.net/about/en/contact.php">contact us</a> for an initial load.</li> </ul> </div> <div class="section" id="how-to-get-access"> <h3>How to get Access<a class="headerlink" href="#how-to-get-access" title="Permalink to this headline">¶</a></h3> <p>Access to the BASE OAI-PMH interface is IP-restricted. Non-commercial projects may apply for access by contacting us via <a class="reference external" href="http://www.base-search.net/about/en/contact.php">this form</a>. Please specify your use case and an IP or IP range from which you need to access the API. You will get an email notification as soon as your IPs have been activated.</p> </div> <div class="section" id="url-of-the-oai-endpoint"> <h3>URL of the OAI Endpoint<a class="headerlink" href="#url-of-the-oai-endpoint" title="Permalink to this headline">¶</a></h3> <p>The OAI endpoint of this API is located at <a class="reference external" href="http://oai.base-search.net/oai">http://oai.base-search.net/oai</a>.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">If your IP is not registered yet (see above), you will face a custom OAI error with error code <code class="docutils literal notranslate"><span class="pre">restrictedInterface</span></code> when trying to access the base URL.</p> </div> </div> </div> <div class="section" id="oai-pmh-primer"> <h2>OAI-PMH Primer<a class="headerlink" href="#oai-pmh-primer" title="Permalink to this headline">¶</a></h2> <p>The API implements the <a class="reference external" href="http://openarchives.org">Open Archives Protocol for Metadata Harvesting (OAI-PMH)</a>. This section gives only a basic overview of OAI-PMH. For more information, please refer to the protocol specification.</p> <div class="section" id="glossary-of-important-oai-pmh-concepts"> <h3>Glossary of Important OAI-PMH Concepts<a class="headerlink" href="#glossary-of-important-oai-pmh-concepts" title="Permalink to this headline">¶</a></h3> <dl class="docutils"> <dt><strong>Repository</strong></dt> <dd>A <em>repository</em> is a server-side application that exposes metadata via OAI-PMH. In the context of this API, the repository is the BASE search engine.</dd> <dt><strong>Harvester</strong></dt> <dd>OAI-PMH client applications are called <em>harvesters</em>.</dd> <dt><strong>record</strong></dt> <dd>A <em>record</em> is the XML-encoded container for the metadata of a single publication item. It consists of a <em>header</em> and a <em>metadata</em> section.</dd> <dt><strong>header</strong></dt> <dd>The record <em>header</em> contains a unique identifier and a datestamp.</dd> <dt><strong>metadata</strong></dt> <dd>The record <em>metadata</em> contains the publication metadata in a defined metadata format.</dd> <dt><strong>set</strong></dt> <dd>A structure for grouping records for selective harvesting.</dd> <dt><strong>harvesting</strong></dt> <dd>The process of requesting records from the repository by the harvester.</dd> </dl> </div> <div class="section" id="oai-verbs"> <h3>OAI Verbs<a class="headerlink" href="#oai-verbs" title="Permalink to this headline">¶</a></h3> <p>OAI-PMH features six main API methods (so-called “OAI verbs”) that can be issued by harvesters. Some verbs can be combined with further arguments:</p> <dl class="docutils"> <dt><code class="docutils literal notranslate"><span class="pre">Identify</span></code></dt> <dd>Returns information about the repository. Arguments: None.</dd> <dt><code class="docutils literal notranslate"><span class="pre">GetRecord</span></code></dt> <dd><p class="first">Returns a single record. Arguments:</p> <ul class="last simple"> <li><code class="docutils literal notranslate"><span class="pre">identifier</span></code> (the unique identifier of the record, <em>required</em>)</li> <li><code class="docutils literal notranslate"><span class="pre">metadataPrefix</span></code> (the prefix identifying the metadata format, <em>required</em>)</li> </ul> </dd> <dt><code class="docutils literal notranslate"><span class="pre">ListRecords</span></code></dt> <dd><p class="first">Returns the records in the repository in batches (possibly filtered by a timestamp or a <code class="docutils literal notranslate"><span class="pre">set</span></code>). Arguments:</p> <ul class="last simple"> <li><code class="docutils literal notranslate"><span class="pre">metadataPrefix</span></code> (the prefix identifying the metadata format, <em>required</em>)</li> <li><code class="docutils literal notranslate"><span class="pre">from</span></code> (the earliest timestamp of the records, <em>optional</em>)</li> <li><code class="docutils literal notranslate"><span class="pre">until</span></code> (the latest timestamp of the records, <em>optional</em>)</li> <li><code class="docutils literal notranslate"><span class="pre">set</span></code> (a set for selective harvesting, <em>optional</em>)</li> <li><code class="docutils literal notranslate"><span class="pre">resumptionToken</span></code> (used for getting the next result batch if the number of records returned by the previous request exceeds the repository’s maximum batch size, <em>exclusive</em>)</li> </ul> </dd> <dt><code class="docutils literal notranslate"><span class="pre">ListIdentifiers</span></code></dt> <dd><em>Like</em> <code class="docutils literal notranslate"><span class="pre">ListRecords</span></code> <em>but returns only the record headers.</em></dd> <dt><code class="docutils literal notranslate"><span class="pre">ListSets</span></code></dt> <dd>Returns the list of sets supported by this repository. Arguments: None</dd> <dt><code class="docutils literal notranslate"><span class="pre">ListMetadataFormats</span></code></dt> <dd>Returns the list of metadata formats supported by this repository. Arguments: None</dd> </dl> </div> <div class="section" id="harvesting-records"> <h3>Harvesting Records<a class="headerlink" href="#harvesting-records" title="Permalink to this headline">¶</a></h3> <p>In the OAI terminology, <em>harvesting</em> refers to the consecutive aggregation of metadata records from a repository. This is done by issueing an initial <code class="docutils literal notranslate"><span class="pre">ListRecords</span></code> request followed by potential resumption requests if the the number of records matching the inital request exceeds the maximum response batch size of the repository. In the latter case, the existence of further records is indicated by the repository through an XML element <code class="docutils literal notranslate"><span class="pre">resumptionToken</span></code> at the bottom of the response. The content of this element has to be provided in the subsequent request.</p> <p>A valid example of an initial request would be:</p> <p><a class="reference external" href="http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=oai_dc">http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=oai_dc</a></p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">The argument <code class="docutils literal notranslate"><span class="pre">metadataPrefix</span></code> specifying the metadata format for record dissemination is required.</p> </div> <p>Given the above request, the <code class="docutils literal notranslate"><span class="pre">resumptionToken</span></code> would be:</p> <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;resumptionToken</span> <span class="na">completeListSize=</span><span class="s">&quot;41398100&quot;</span> <span class="na">cursor=</span><span class="s">&quot;0&quot;</span><span class="nt">&gt;</span> fm9haV9kY34yMDB-fg== <span class="nt">&lt;/resumptionToken&gt;</span> </pre></div> </div> <p>To fetch the next batch of records, the client would then need to issue the following request:</p> <p><a class="reference external" href="http://oai.base-search.net/oai?verb=ListRecords&amp;resumptionToken=fm9haV9kY34yMDB-fg==">http://oai.base-search.net/oai?verb=ListRecords&amp;resumptionToken=fm9haV9kY34yMDB-fg==</a></p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">The <code class="docutils literal notranslate"><span class="pre">resumptionToken</span></code> argument is <em>exclusive</em>. Additional arguments provided with the initial request like <code class="docutils literal notranslate"><span class="pre">metadataPrefix</span></code> or <code class="docutils literal notranslate"><span class="pre">set</span></code> therefore <strong>must not</strong> be included in resumption requests. Also note that the <code class="docutils literal notranslate"><span class="pre">resumptionToken</span></code> XML element carries two attributes <code class="docutils literal notranslate"><span class="pre">completeListSize</span></code> referring to the total number of records matching the request and <code class="docutils literal notranslate"><span class="pre">cursor</span></code> referring to the number of records returned so far. Clients are strongly encouraged to keep track of this information and include it in issue reports about the interface.</p> </div> </div> </div> <div class="section" id="metadata-formats"> <h2>Metadata Formats<a class="headerlink" href="#metadata-formats" title="Permalink to this headline">¶</a></h2> <p>Currently, this API supports two metadata formats: OAI-DC (Dublin Core, metadata prefix <code class="docutils literal notranslate"><span class="pre">oai_dc</span></code>) and BASE-DC (OAI-DC extended with custom fields, metadata prefix <code class="docutils literal notranslate"><span class="pre">base_dc</span></code>). Further formats may follow in the future.</p> <div class="section" id="oai-dc"> <h3><code class="docutils literal notranslate"><span class="pre">oai_dc</span></code><a class="headerlink" href="#oai-dc" title="Permalink to this headline">¶</a></h3> <p>The <code class="docutils literal notranslate"><span class="pre">oai_dc</span></code> format exposes the metadata encoded as <a class="reference external" href="http://dublincore.org/documents/dces/">Dublin Core</a>. The following listing shows an example record encoded in <code class="docutils literal notranslate"><span class="pre">oai_dc</span></code>:</p> <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;record&gt;</span> <span class="nt">&lt;header&gt;</span> <span class="nt">&lt;identifier&gt;</span>ftubbiepub:oai:pub.uni-bielefeld.de:1680979<span class="nt">&lt;/identifier&gt;</span> <span class="nt">&lt;datestamp&gt;</span>2016-02-21T23:44:21Z<span class="nt">&lt;/datestamp&gt;</span> <span class="nt">&lt;/header&gt;</span> <span class="nt">&lt;metadata&gt;</span> <span class="nt">&lt;oai_dc:dc</span> <span class="na">xmlns:dc=</span><span class="s">&quot;http://purl.org/dc/elements/1.1/&quot;</span> <span class="na">xmlns:oai_dc=</span><span class="s">&quot;http://www.openarchives.org/OAI/2.0/oai_dc/&quot;</span> <span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.openarchives.org/OAI/2.0/oai_dc/</span> <span class="s"> http://www.openarchives.org/OAI/2.0/oai_dc.xsd&quot;</span><span class="nt">&gt;</span> <span class="nt">&lt;dc:title&gt;</span>Bielefeld Academic Search Engine (BASE) An end-user oriented institutional repository search service<span class="nt">&lt;/dc:title&gt;</span> <span class="nt">&lt;dc:creator&gt;</span>Pieper, Dirk<span class="nt">&lt;/dc:creator&gt;</span> <span class="nt">&lt;dc:creator&gt;</span>Summann, Friedrich<span class="nt">&lt;/dc:creator&gt;</span> <span class="nt">&lt;dc:description&gt;</span>Purpose - The purpose of this paper is …<span class="nt">&lt;/dc:description&gt;</span> <span class="nt">&lt;dc:source&gt;</span> Pieper D, Summann F.: Bielefeld Academic Search Engine (BASE). An end-user oriented institutional repository search service. Library Hi Tech. 2006; 24(4):614–619. <span class="nt">&lt;/dc:source&gt;</span> <span class="nt">&lt;dc:source&gt;</span>ftubbiepub<span class="nt">&lt;/dc:source&gt;</span> <span class="nt">&lt;dc:language&gt;</span>eng<span class="nt">&lt;/dc:language&gt;</span> <span class="nt">&lt;dc:date&gt;</span>2006<span class="nt">&lt;/dc:date&gt;</span> <span class="nt">&lt;dc:identifier&gt;</span> https://pub.uni-bielefeld.de/publication/1680979 <span class="nt">&lt;/dc:identifier&gt;</span> <span class="nt">&lt;dc:identifier&gt;</span> https://pub.uni-bielefeld.de/download/1680979/2535619 <span class="nt">&lt;/dc:identifier&gt;</span> <span class="nt">&lt;dc:relation&gt;</span> info:eu-repo/semantics/altIdentifier/doi/10.1108/07378830610715473 <span class="nt">&lt;/dc:relation&gt;</span> <span class="nt">&lt;dc:relation&gt;</span> info:eu-repo/semantics/altIdentifier/issn/0737-8831 <span class="nt">&lt;/dc:relation&gt;</span> <span class="nt">&lt;dc:relation&gt;</span> info:eu-repo/semantics/altIdentifier/wos/000242893300014 <span class="nt">&lt;/dc:relation&gt;</span> <span class="nt">&lt;dc:subject&gt;</span>Bielefeld Academic Search Engine<span class="nt">&lt;/dc:subject&gt;</span> <span class="nt">&lt;dc:subject&gt;</span>ddc:020<span class="nt">&lt;/dc:subject&gt;</span> <span class="nt">&lt;dc:type&gt;</span>info:eu-repo/semantics/article<span class="nt">&lt;/dc:type&gt;</span> <span class="nt">&lt;dc:type&gt;</span>doc-type:article<span class="nt">&lt;/dc:type&gt;</span> <span class="nt">&lt;dc:type&gt;</span>text<span class="nt">&lt;/dc:type&gt;</span> <span class="nt">&lt;dc:type&gt;</span>121<span class="nt">&lt;/dc:type&gt;</span> <span class="nt">&lt;dc:rights&gt;</span>info:eu-repo/semantics/openAccess<span class="nt">&lt;/dc:rights&gt;</span> <span class="nt">&lt;/oai_dc:dc&gt;</span> <span class="nt">&lt;/metadata&gt;</span> <span class="nt">&lt;/record&gt;</span> </pre></div> </div> </div> <div class="section" id="base-dc"> <h3><code class="docutils literal notranslate"><span class="pre">base_dc</span></code><a class="headerlink" href="#base-dc" title="Permalink to this headline">¶</a></h3> <p>The <code class="docutils literal notranslate"><span class="pre">base_dc</span></code> format extends the Dublin Core format with extra elements containing information that has been added or normalized by BASE. These elements are listed in the following table.</p> <dl class="docutils"> <dt>Namespace:</dt> <dd><a class="reference external" href="http://oai.base-search.net/base_dc/">http://oai.base-search.net/base_dc/</a></dd> <dt>XML Schema:</dt> <dd><a class="reference external" href="http://oai.base-search.net/base_dc/base_dc.xsd">http://oai.base-search.net/base_dc/base_dc.xsd</a></dd> </dl> <table border="1" class="docutils" id="id2"> <caption><span class="caption-text">Additional XML elements of <code class="docutils literal notranslate"><span class="pre">base_dc</span></code></span><a class="headerlink" href="#id2" title="Permalink to this table">¶</a></caption> <colgroup> <col width="12%" /> <col width="16%" /> <col width="72%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Element</th> <th class="head">Value Format</th> <th class="head">Description</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">author_id</span></code></td> <td>contains 2 XML elements:</td> <td><code class="docutils literal notranslate"><span class="pre">&lt;creator_name&gt;</span></code> and <code class="docutils literal notranslate"><span class="pre">&lt;creator_id&gt;</span></code></td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">autoclasscode</span></code></td> <td>1-3 digit Dewey number</td> <td>Automatically assigned Dewey number.</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">classcode</span></code></td> <td>1-3 digit Dewey number</td> <td>Manually assigned Dewey number.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">collection</span></code></td> <td>BASE collection name</td> <td>Internal identifier of original repository. May contain the XML attributes <code class="docutils literal notranslate"><span class="pre">opendoar_id</span></code> and/or <code class="docutils literal notranslate"><span class="pre">ror_id</span></code>.</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">collname</span></code></td> <td>full collection name</td> <td>Full name of the original repository.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">continent</span></code></td> <td>3 digit code (see below)</td> <td>Continent of provenance (repository).</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">country</span></code></td> <td>ISO 3166 country code</td> <td>Country of provenance (repository).</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">creator_id</span></code></td> <td>URI</td> <td>ORCID iD written as a URL</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">creator_name</span></code></td> <td>character string</td> <td>repeats a name also given in <code class="docutils literal notranslate"><span class="pre">&lt;creator&gt;</span></code></td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">doi</span></code></td> <td>URI</td> <td>DOI (Digital Object Identifier) of this document</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">global_id</span></code></td> <td>Free text (in UTF-8)</td> <td>copy of <a class="reference external" href="#id1">identifier</a> from the record header</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">lang</span></code></td> <td>ISO 639-2/B language code</td> <td>Three-letter document language code normalized by BASE, or <code class="docutils literal notranslate"><span class="pre">unknown</span></code>.</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">link</span></code></td> <td>URI</td> <td>Canonical link to the repository splash page.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">oa</span></code></td> <td>1 digit code</td> <td>Open Access status (<code class="docutils literal notranslate"><span class="pre">0</span></code> = Not Open Access, <code class="docutils literal notranslate"><span class="pre">1</span></code> = Open Access, <code class="docutils literal notranslate"><span class="pre">2</span></code> = unknown)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">rightsnorm</span></code></td> <td>controlled list see below</td> <td>Licensing information normalized by BASE.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">typenorm</span></code></td> <td>alphanumeric code</td> <td>Alphanumerically encoded normalized document type.</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">year</span></code></td> <td>4 digit year</td> <td>Normalized publication year.</td> </tr> </tbody> </table> <p>Below is the example record from the previous section encoded in <code class="docutils literal notranslate"><span class="pre">base_dc</span></code> (an ellipsis […] marks abbreviations made for readability):</p> <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;record&gt;</span> <span class="nt">&lt;header&gt;</span> <span class="nt">&lt;identifier&gt;</span>ftubbiepub:oai:pub.uni-bielefeld.de:1680979<span class="nt">&lt;/identifier&gt;</span> <span class="nt">&lt;datestamp&gt;</span>2023-05-11T20:06:51Z<span class="nt">&lt;/datestamp&gt;</span> <span class="nt">&lt;/header&gt;</span> <span class="nt">&lt;metadata&gt;</span> <span class="nt">&lt;base_dc:dc</span> <span class="na">xmlns:base_dc=</span><span class="s">&quot;http://oai.base-search.net/base_dc/&quot;</span> <span class="na">xmlns:dc=</span><span class="s">&quot;http://purl.org/dc/elements/1.1/&quot;</span> <span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://oai.base-search.net/base_dc/</span> <span class="s"> http://oai.base-search.net/base_dc/base_dc.xsd&quot;</span><span class="nt">&gt;</span> <span class="nt">&lt;dc:title&gt;</span>Bielefeld Academic Search Engine (BASE) An end-user oriented institutional repository search service<span class="nt">&lt;/dc:title&gt;</span> <span class="nt">&lt;dc:creator&gt;</span>Pieper, Dirk<span class="nt">&lt;/dc:creator&gt;</span> <span class="nt">&lt;dc:creator&gt;</span>Summann, Friedrich<span class="nt">&lt;/dc:creator&gt;</span> <span class="nt">&lt;base_dc:author_id&gt;</span> <span class="nt">&lt;base_dc:creator_name&gt;</span>Pieper, Dirk<span class="nt">&lt;/base_dc:creator_name&gt;</span> <span class="nt">&lt;base_dc:creator_id&gt;</span>https://orcid.org/0000-0002-6083-9348<span class="nt">&lt;/base_dc:creator_id&gt;</span> <span class="nt">&lt;/base_dc:author_id&gt;</span> <span class="nt">&lt;base_dc:author_id&gt;</span> <span class="nt">&lt;base_dc:creator_name&gt;</span>Summann, Friedrich<span class="nt">&lt;/base_dc:creator_name&gt;</span> <span class="nt">&lt;base_dc:creator_id&gt;</span>https://orcid.org/0000-0002-6297-3348<span class="nt">&lt;/base_dc:creator_id&gt;</span> <span class="nt">&lt;/base_dc:author_id&gt;</span> <span class="nt">&lt;dc:description&gt;</span>Purpose - The purpose of this paper is …<span class="nt">&lt;/dc:description&gt;</span> <span class="nt">&lt;dc:language&gt;</span>eng<span class="nt">&lt;/dc:language&gt;</span> <span class="nt">&lt;dc:date&gt;</span>2006<span class="nt">&lt;/dc:date&gt;</span> <span class="nt">&lt;dc:identifier&gt;</span>https://nbn-resolving.org/urn:nbn:de:0070-pub-16809798<span class="nt">&lt;/dc:identifier&gt;</span> <span class="nt">&lt;dc:identifier&gt;</span>https://pub.uni-bielefeld.de/record/1680979<span class="nt">&lt;/dc:identifier&gt;</span> <span class="nt">&lt;dc:identifier&gt;</span>https://pub.uni-bielefeld.de/download/1680979/2535619<span class="nt">&lt;/dc:identifier&gt;</span> <span class="nt">&lt;base_dc:doi&gt;</span>https://doi.org/10.1108/07378830610715473<span class="nt">&lt;/base_dc:doi&gt;</span> <span class="nt">&lt;dc:relation&gt;</span>info:eu-repo/semantics/altIdentifier/doi/10.1108/07378830610715473<span class="nt">&lt;/dc:relation&gt;</span> <span class="nt">&lt;dc:relation&gt;</span>info:eu-repo/semantics/altIdentifier/issn/0737-8831<span class="nt">&lt;/dc:relation&gt;</span> <span class="nt">&lt;dc:relation&gt;</span>info:eu-repo/semantics/altIdentifier/wos/000242893300014<span class="nt">&lt;/dc:relation&gt;</span> <span class="nt">&lt;dc:relation&gt;</span>https://nbn-resolving.org/urn:nbn:de:0070-pub-16809798<span class="nt">&lt;/dc:relation&gt;</span> <span class="nt">&lt;dc:relation&gt;</span>https://pub.uni-bielefeld.de/record/1680979<span class="nt">&lt;/dc:relation&gt;</span> <span class="nt">&lt;dc:relation&gt;</span>https://pub.uni-bielefeld.de/download/1680979/2535619<span class="nt">&lt;/dc:relation&gt;</span> <span class="nt">&lt;dc:subject&gt;</span>Bielefeld Academic Search Engine<span class="nt">&lt;/dc:subject&gt;</span> <span class="nt">&lt;dc:subject&gt;</span>ddc:020<span class="nt">&lt;/dc:subject&gt;</span> <span class="nt">&lt;dc:publisher&gt;</span>Emerald<span class="nt">&lt;/dc:publisher&gt;</span> <span class="nt">&lt;dc:type&gt;</span>http://purl.org/coar/resource_type/c_6501<span class="nt">&lt;/dc:type&gt;</span> <span class="nt">&lt;dc:type&gt;</span>info:eu-repo/semantics/article<span class="nt">&lt;/dc:type&gt;</span> <span class="nt">&lt;dc:type&gt;</span>doc-type:article<span class="nt">&lt;/dc:type&gt;</span> <span class="nt">&lt;dc:type&gt;</span>text<span class="nt">&lt;/dc:type&gt;</span> <span class="nt">&lt;dc:rights&gt;</span>info:eu-repo/semantics/openAccess ; https://rightsstatements.org/vocab/InC/1.0/<span class="nt">&lt;/dc:rights&gt;</span> <span class="nt">&lt;base_dc:classcode</span> <span class="na">type=</span><span class="s">&quot;ddc&quot;</span><span class="nt">&gt;</span>020<span class="nt">&lt;/base_dc:classcode&gt;</span> <span class="nt">&lt;base_dc:collection</span> <span class="na">opendoar_id=</span><span class="s">&quot;2294&quot;</span> <span class="na">ror_id=</span><span class="s">&quot;02hpadn98&quot;</span><span class="nt">&gt;</span>ftubbiepub<span class="nt">&lt;/base_dc:collection&gt;</span> <span class="nt">&lt;base_dc:collname&gt;</span>PUB - Publications at Bielefeld Uni…<span class="nt">&lt;/base_dc:collname&gt;</span> <span class="nt">&lt;base_dc:continent&gt;</span>ceu<span class="nt">&lt;/base_dc:continent&gt;</span> <span class="nt">&lt;base_dc:country&gt;</span>de<span class="nt">&lt;/base_dc:country&gt;</span> <span class="nt">&lt;base_dc:global_id&gt;</span>ftubbiepub:oai:pub.uni-bielefeld.de:1680979<span class="nt">&lt;/base_dc:global_id&gt;</span> <span class="nt">&lt;base_dc:lang&gt;</span>eng<span class="nt">&lt;/base_dc:lang&gt;</span> <span class="nt">&lt;base_dc:link&gt;</span>https://nbn-resolving.org/urn:nbn:de:0070-pub-16809798<span class="nt">&lt;/base_dc:link&gt;</span> <span class="nt">&lt;base_dc:oa&gt;</span>1<span class="nt">&lt;/base_dc:oa&gt;</span> <span class="nt">&lt;base_dc:typenorm&gt;</span>121<span class="nt">&lt;/base_dc:typenorm&gt;</span> <span class="nt">&lt;base_dc:year&gt;</span>2006<span class="nt">&lt;/base_dc:year&gt;</span> <span class="nt">&lt;/base_dc:dc&gt;</span> <span class="nt">&lt;/metadata&gt;</span> <span class="nt">&lt;/record&gt;</span> </pre></div> </div> </div> </div> <div class="section" id="record-headers"> <h2>Record Headers<a class="headerlink" href="#record-headers" title="Permalink to this headline">¶</a></h2> <div class="section" id="id1"> <h3><code class="docutils literal notranslate"><span class="pre">identifier</span></code><a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3> <p>The unique identifier in the record headers consists of the OAI identifier assigned by the original repository, prefixed with the internal BASE repository identifier. For instance, in the following example identifier</p> <p><code class="docutils literal notranslate"><span class="pre">ftubbiepub:oai:pub.uni-bielefeld.de:2083906</span></code></p> <p>the original identifier was <code class="docutils literal notranslate"><span class="pre">oai:pub.uni-bielefeld.de:2083906</span></code> and the prefix <code class="docutils literal notranslate"><span class="pre">ftubbiepub:</span></code> is BASE’s internal name for the repository of Bielefeld University, “PUB”.</p> </div> <div class="section" id="datestamp"> <h3><code class="docutils literal notranslate"><span class="pre">datestamp</span></code><a class="headerlink" href="#datestamp" title="Permalink to this headline">¶</a></h3> <p>The <code class="docutils literal notranslate"><span class="pre">datestamp</span></code> element in the record header contains the date of harvesting into BASE.</p> </div> <div class="section" id="deleted-records"> <h3>Deleted Records<a class="headerlink" href="#deleted-records" title="Permalink to this headline">¶</a></h3> <p>This OAI-PMH interface does <strong>not</strong> keep track of deleted records.</p> </div> </div> <div class="section" id="date-ranges"> <h2>Date Ranges<a class="headerlink" href="#date-ranges" title="Permalink to this headline">¶</a></h2> <p>OAI-PMH allows selective harvesting by date via the <code class="docutils literal notranslate"><span class="pre">from</span></code> and <code class="docutils literal notranslate"><span class="pre">until</span></code> parameters. In the BASE OAI-PMH API, the semantics of these dates is the <em>date of harvesting</em>, i.e., when the content was fetched from the original repositories into the BASE infrastructure. For instance, to get all contents that have been included into BASE from May to June 2012, you could use:</p> <p><a class="reference external" href="http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=oai_dc&amp;from=2012-05-01&amp;until=2012-06-30">http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=oai_dc&amp;from=2012-05-01&amp;until=2012-06-30</a></p> <p>If you would like to filter for the <em>date of publication</em> instead, please specify a dynamic set using the <code class="docutils literal notranslate"><span class="pre">date</span></code> field (see below).</p> </div> <div class="section" id="dynamic-sets"> <h2>Dynamic Sets<a class="headerlink" href="#dynamic-sets" title="Permalink to this headline">¶</a></h2> <p>Traditionally, OAI-PMH structures content into collections by using sets. However, the protocol does not support combinations of multiple sets. To overcome this static nature of OAI sets, this API uses <em>dynamic sets</em> (inspired by <a class="reference external" href="http://oai.datacite.org/">DataCite’s OAI interface</a>).</p> <p>This means that you can specify sets using the Solr query syntax <code class="docutils literal notranslate"><span class="pre">field:value</span></code>.</p> <p>For instance, if you would like to filter for manually classified records from the field of economics from Germany, you could use the following set:</p> <p><a class="reference external" href="http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=oai_dc&amp;set=classcode:33*+country:de">http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=oai_dc&amp;set=classcode:33*+country:de</a></p> <p>The supported fields are documented in the next section.</p> </div> <div class="section" id="indexed-and-normalized-fields"> <h2>Indexed and Normalized Fields<a class="headerlink" href="#indexed-and-normalized-fields" title="Permalink to this headline">¶</a></h2> <p>BASE puts considerable efforts into the normalization of the (often heterogenously used) Dublin Core fields harvested from the original repositories. This section gives an overview of the queryable fields, their contents, and (if applicable) their normalization. The fields can be queried by using dynamic sets, as described in the previous section.</p> <div class="section" id="overview-of-indexed-fields"> <h3>Overview of Indexed Fields<a class="headerlink" href="#overview-of-indexed-fields" title="Permalink to this headline">¶</a></h3> <table border="1" class="docutils" id="id3"> <caption><span class="caption-text">Queryable fields.</span><a class="headerlink" href="#id3" title="Permalink to this table">¶</a></caption> <colgroup> <col width="18%" /> <col width="22%" /> <col width="60%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Field</th> <th class="head">Value Format</th> <th class="head">Description</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">autoclasscode</span></code></td> <td>1-3 digit Dewey number</td> <td>Automatically assigned Dewey number.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">classcode</span></code></td> <td>1-3 digit Dewey number</td> <td>Manually assigned Dewey number.</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">collection</span></code></td> <td>BASE collection name</td> <td>Original repository.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">continent</span></code></td> <td>3 digit code (see below)</td> <td>Continent of provenance (repository).</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">contributor</span></code></td> <td>Free text (in UTF-8)</td> <td>Contributor to the publication</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">country</span></code></td> <td>ISO 3166 country code</td> <td>Country of provenance (repository).</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">creator</span></code></td> <td>Free text (in UTF-8)</td> <td>Author of the publication.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">date</span></code></td> <td>Free text (in UTF-8)</td> <td>Date of publication.</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">deweyfull</span></code></td> <td>1-3 digit Dewey number</td> <td>Manually + automatically assigned Dewey numbers.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">description</span></code></td> <td>Free text (in UTF-8)</td> <td>Abstract.</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">format</span></code></td> <td>Free text (in UTF-8)</td> <td>Document format (e.g., MIME).</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">identifier</span></code></td> <td>Free text (in UTF-8)</td> <td>Document identifier (e.g., URI).</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">lang</span></code></td> <td>ISO 639-2/B language code</td> <td>Document language as 3 letter code normalized by BASE, or “unknown”.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">language</span></code></td> <td>Free text (in UTF-8)</td> <td>Document language as in the original repository.</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">link</span></code></td> <td>URI</td> <td>Canonical link to the repository splash page.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">oa</span></code></td> <td>1 digit code</td> <td>Open Access status (1 = “Open Access”, 2 = “unknown”)</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">person</span></code></td> <td>Free text (in UTF-8)</td> <td>Authors + contributors.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">rightsnorm</span></code></td> <td>controlled list see below</td> <td>License information normalized by BASE.</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">subject</span></code></td> <td>Free text (in UTF-8)</td> <td>Subject headings.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">title</span></code></td> <td>Free text (in UTF-8)</td> <td>Document title.</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">typenorm</span></code></td> <td>alphanumeric code</td> <td>Alphanumerically encoded normalized document type.</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">year</span></code></td> <td>4 digit year</td> <td>Normalized publication year.</td> </tr> </tbody> </table> </div> <div class="section" id="document-types"> <h3>Document Types<a class="headerlink" href="#document-types" title="Permalink to this headline">¶</a></h3> <p>As the categorization of document types is very heterogenous across repositories, BASE normalizes them by mapping types into consistent categories which are identified by a numerical code. The table below lists normalized document types, which can be queried by using the field <code class="docutils literal notranslate"><span class="pre">typenorm</span></code>.</p> <table border="1" class="docutils" id="id4"> <caption><span class="caption-text">Numeric codes for normalized document types.</span><a class="headerlink" href="#id4" title="Permalink to this table">¶</a></caption> <colgroup> <col width="76%" /> <col width="24%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">document type</th> <th class="head">numeric code</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td>text</td> <td><code class="docutils literal notranslate"><span class="pre">1</span></code></td> </tr> <tr class="row-odd"><td>book</td> <td><code class="docutils literal notranslate"><span class="pre">11</span></code></td> </tr> <tr class="row-even"><td>book part</td> <td><code class="docutils literal notranslate"><span class="pre">111</span></code></td> </tr> <tr class="row-odd"><td>journal/newspaper</td> <td><code class="docutils literal notranslate"><span class="pre">12</span></code></td> </tr> <tr class="row-even"><td>article in journal/newspaper</td> <td><code class="docutils literal notranslate"><span class="pre">121</span></code></td> </tr> <tr class="row-odd"><td>other non-article part of journal/newspaper</td> <td><code class="docutils literal notranslate"><span class="pre">122</span></code></td> </tr> <tr class="row-even"><td>conference object</td> <td><code class="docutils literal notranslate"><span class="pre">13</span></code></td> </tr> <tr class="row-odd"><td>report</td> <td><code class="docutils literal notranslate"><span class="pre">14</span></code></td> </tr> <tr class="row-even"><td>review</td> <td><code class="docutils literal notranslate"><span class="pre">15</span></code></td> </tr> <tr class="row-odd"><td>course material</td> <td><code class="docutils literal notranslate"><span class="pre">16</span></code></td> </tr> <tr class="row-even"><td>lecture</td> <td><code class="docutils literal notranslate"><span class="pre">17</span></code></td> </tr> <tr class="row-odd"><td>thesis</td> <td><code class="docutils literal notranslate"><span class="pre">18</span></code></td> </tr> <tr class="row-even"><td>bachelor thesis</td> <td><code class="docutils literal notranslate"><span class="pre">181</span></code></td> </tr> <tr class="row-odd"><td>master thesis</td> <td><code class="docutils literal notranslate"><span class="pre">182</span></code></td> </tr> <tr class="row-even"><td>doctoral or postdoctoral thesis</td> <td><code class="docutils literal notranslate"><span class="pre">183</span></code></td> </tr> <tr class="row-odd"><td>manuscript</td> <td><code class="docutils literal notranslate"><span class="pre">19</span></code></td> </tr> <tr class="row-even"><td>patent</td> <td><code class="docutils literal notranslate"><span class="pre">1A</span></code></td> </tr> <tr class="row-odd"><td>musical notation</td> <td><code class="docutils literal notranslate"><span class="pre">2</span></code></td> </tr> <tr class="row-even"><td>map</td> <td><code class="docutils literal notranslate"><span class="pre">3</span></code></td> </tr> <tr class="row-odd"><td>audio</td> <td><code class="docutils literal notranslate"><span class="pre">4</span></code></td> </tr> <tr class="row-even"><td>image or video</td> <td><code class="docutils literal notranslate"><span class="pre">5</span></code></td> </tr> <tr class="row-odd"><td>still image</td> <td><code class="docutils literal notranslate"><span class="pre">51</span></code></td> </tr> <tr class="row-even"><td>moving image (video)</td> <td><code class="docutils literal notranslate"><span class="pre">52</span></code></td> </tr> <tr class="row-odd"><td>software</td> <td><code class="docutils literal notranslate"><span class="pre">6</span></code></td> </tr> <tr class="row-even"><td>dataset</td> <td><code class="docutils literal notranslate"><span class="pre">7</span></code></td> </tr> <tr class="row-odd"><td>other/unknown material</td> <td><code class="docutils literal notranslate"><span class="pre">F</span></code></td> </tr> </tbody> </table> <p class="rubric">Example Query:</p> <p>Filter for books:</p> <p><a class="reference external" href="http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=base_dc&amp;set=typenorm:11">http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=base_dc&amp;set=typenorm:11</a></p> <p class="rubric">Encoding in the <code class="docutils literal notranslate"><span class="pre">base_dc</span></code> format:</p> <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;base_dc:typenorm&gt;</span>11<span class="nt">&lt;/base_dc:typenorm&gt;</span> </pre></div> </div> </div> <div class="section" id="continents-and-countries"> <h3>Continents and Countries<a class="headerlink" href="#continents-and-countries" title="Permalink to this headline">¶</a></h3> <p>BASE keeps track of the origins of its contents by storing the continent and country of the original repositories. Countries are encoded by using ISO 3166 country codes. Continents are encoded as shown in the following table:</p> <table border="1" class="docutils" id="id5"> <caption><span class="caption-text">Codes for continents.</span><a class="headerlink" href="#id5" title="Permalink to this table">¶</a></caption> <colgroup> <col width="82%" /> <col width="18%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Continent</th> <th class="head">Code</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td>Africa</td> <td><code class="docutils literal notranslate"><span class="pre">caf</span></code></td> </tr> <tr class="row-odd"><td>Australia</td> <td><code class="docutils literal notranslate"><span class="pre">cas</span></code></td> </tr> <tr class="row-even"><td>Australia/Oceania</td> <td><code class="docutils literal notranslate"><span class="pre">cau</span></code></td> </tr> <tr class="row-odd"><td>Europe</td> <td><code class="docutils literal notranslate"><span class="pre">ceu</span></code></td> </tr> <tr class="row-even"><td>North America</td> <td><code class="docutils literal notranslate"><span class="pre">cna</span></code></td> </tr> <tr class="row-odd"><td>South America</td> <td><code class="docutils literal notranslate"><span class="pre">csa</span></code></td> </tr> <tr class="row-even"><td>Web server without geographic relation (org)</td> <td><code class="docutils literal notranslate"><span class="pre">cww</span></code></td> </tr> </tbody> </table> <p class="rubric">Country Example Query:</p> <p>Filter for documents from Germany:</p> <p><a class="reference external" href="http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=base_dc&amp;set=country:de">http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=base_dc&amp;set=country:de</a></p> <p class="rubric">Encoding in the <code class="docutils literal notranslate"><span class="pre">base_dc</span></code> format:</p> <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;base_dc:country&gt;</span>de<span class="nt">&lt;/base_dc:country&gt;</span> </pre></div> </div> <p class="rubric">Continent Example Query:</p> <p>Filter for documents from North America:</p> <p><a class="reference external" href="http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=base_dc&amp;set=continent:cna">http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=base_dc&amp;set=continent:cna</a></p> <p class="rubric">Encoding in the <code class="docutils literal notranslate"><span class="pre">base_dc</span></code> format:</p> <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;base_dc:continent&gt;</span>cna<span class="nt">&lt;/base_dc:continent&gt;</span> </pre></div> </div> </div> <div class="section" id="subject-classification"> <h3>Subject Classification<a class="headerlink" href="#subject-classification" title="Permalink to this headline">¶</a></h3> <p>The BASE index supports the <a class="reference external" href="http://en.wikipedia.org/wiki/Dewey_Decimal_Classification">Dewey Decimal Classification (DDC)</a> for subject categorization. The assignment of Dewey classes to documents is established in two ways:</p> <ol class="arabic simple"> <li><strong>manually</strong> for contents from repositories that use the DDC.</li> <li><strong>automatically</strong> through machine learning-based document categorization.</li> </ol> <p>Depending on their origin, the Dewey numbers are either stored in the field <code class="docutils literal notranslate"><span class="pre">classcode</span></code> (for manually assigned numbers) or <code class="docutils literal notranslate"><span class="pre">autoclasscode</span></code> (for automatically assigned numbers). The field <code class="docutils literal notranslate"><span class="pre">deweyfull</span></code> can be used for querying both manually and automatically classified documents.</p> <p class="rubric">Example Queries:</p> <p>Filter for mathematical documents (manually and automatically classified):</p> <p><a class="reference external" href="http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=base_dc&amp;set=deweyfull:51*">http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=base_dc&amp;set=deweyfull:51*</a></p> <p>Filter for manually classified mathematical documents:</p> <p><a class="reference external" href="http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=base_dc&amp;set=classcode:51*">http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=base_dc&amp;set=classcode:51*</a></p> <p>Filter for automatically classified mathematical documents:</p> <p><a class="reference external" href="http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=base_dc&amp;set=autoclasscode:51*">http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=base_dc&amp;set=autoclasscode:51*</a></p> <p class="rubric">Encoding in the <code class="docutils literal notranslate"><span class="pre">base_dc</span></code> format:</p> <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;base_dc:classcode</span> <span class="na">type=</span><span class="s">&quot;ddc&quot;</span><span class="nt">&gt;</span>510<span class="nt">&lt;/base_dc:classcode&gt;</span> </pre></div> </div> <p>Conversely, if the class was assigned automatically, it would look like this:</p> <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;base_dc:autoclasscode</span> <span class="na">type=</span><span class="s">&quot;ddc&quot;</span><span class="nt">&gt;</span>510<span class="nt">&lt;/base_dc:autoclasscode&gt;</span> </pre></div> </div> </div> <div class="section" id="open-access-status"> <h3>Open Access Status<a class="headerlink" href="#open-access-status" title="Permalink to this headline">¶</a></h3> <p>BASE indexes the Open Access status of full text documents where this information is available. The status is stored numerically encoded in the field <code class="docutils literal notranslate"><span class="pre">oa</span></code>.</p> <table border="1" class="docutils" id="id6"> <caption><span class="caption-text">Encoding of Open Access</span><a class="headerlink" href="#id6" title="Permalink to this table">¶</a></caption> <colgroup> <col width="31%" /> <col width="69%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Status Code</th> <th class="head">Description</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">0</span></code></td> <td>Not Open Access</td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">1</span></code></td> <td>Open Access</td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">2</span></code></td> <td>Unknown</td> </tr> </tbody> </table> <p class="rubric">Example Query:</p> <p>Filter for Open Access documents:</p> <p><a class="reference external" href="http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=base_dc&amp;set=oa:1">http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=base_dc&amp;set=oa:1</a></p> <p class="rubric">Encoding in the <code class="docutils literal notranslate"><span class="pre">base_dc</span></code> format:</p> <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;base_dc:oa&gt;</span>1<span class="nt">&lt;/base_dc:oa&gt;</span> </pre></div> </div> </div> <div class="section" id="licensing-information"> <h3>Licensing Information<a class="headerlink" href="#licensing-information" title="Permalink to this headline">¶</a></h3> <p>A great variety of values for the <code class="docutils literal notranslate"><span class="pre">dc:rights</span></code> field can be encountered in the wild. BASE maps those values it can recognise onto the following list of license codes. No attempt is made to recognise version numbers.</p> <table border="1" class="docutils" id="id7"> <caption><span class="caption-text">Encoding of licensing information</span><a class="headerlink" href="#id7" title="Permalink to this table">¶</a></caption> <colgroup> <col width="12%" /> <col width="88%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Rightsnorm Code</th> <th class="head">Description</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">CC-BY-NC-ND</span></code></td> <td><a class="reference external" href="https://creativecommons.org/licenses/by-nc-nd/4.0/">Creative Commons Attribution-NonCommercial-NoDerivatives</a></td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">CC-BY-NC-SA</span></code></td> <td><a class="reference external" href="https://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike</a></td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">CC-BY-SA</span></code></td> <td><a class="reference external" href="https://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike</a></td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">CC-BY-ND</span></code></td> <td><a class="reference external" href="https://creativecommons.org/licenses/by-nd/4.0/">Creative Commons Attribution-NoDerivatives</a></td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">CC-BY-NC</span></code></td> <td><a class="reference external" href="https://creativecommons.org/licenses/by-nc/4.0/">Creative Commons Attribution-NonCommercial</a></td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">CC-BY</span></code></td> <td><a class="reference external" href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution</a></td> </tr> <tr class="row-even"><td><code class="docutils literal notranslate"><span class="pre">CC0</span></code></td> <td><a class="reference external" href="https://creativecommons.org/publicdomain/zero/1.0/">Public Domain Dedication</a></td> </tr> <tr class="row-odd"><td><code class="docutils literal notranslate"><span class="pre">PDM</span></code></td> <td><a class="reference external" href="https://creativecommons.org/publicdomain/mark/1.0/">Public Domain Mark</a></td> </tr> </tbody> </table> <p class="rubric">Example Query:</p> <p>Filter for Creative Commons Attribution (CC-BY) licensed documents:</p> <p><a class="reference external" href="http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=base_dc&amp;set=rightsnorm:CC-BY">http://oai.base-search.net/oai?verb=ListRecords&amp;metadataPrefix=base_dc&amp;set=rightsnorm:CC-BY</a></p> <p class="rubric">Encoding in the <code class="docutils literal notranslate"><span class="pre">base_dc</span></code> format:</p> <div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt">&lt;base_dc:rightsnorm&gt;</span>CC-BY<span class="nt">&lt;/base_dc:rightsnorm&gt;</span> </pre></div> </div> </div> </div> </div> </div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <p class="logo"><a href="index.html#document-index"> <img class="logo" src="_static/logo_base.png" alt="Logo"/> </a></p> <h3><a href="index.html#document-index">Table of Contents</a></h3> <ul> <li class="toctree-l1"><a class="reference internal" href="index.html#document-intro">Introduction</a><ul> <li class="toctree-l2"><a class="reference internal" href="index.html#pdf-download">PDF Download</a></li> <li class="toctree-l2"><a class="reference internal" href="index.html#what-is-it-for">What is it for?</a></li> <li class="toctree-l2"><a class="reference internal" href="index.html#alternatives">Alternatives</a></li> <li class="toctree-l2"><a class="reference internal" href="index.html#how-to-get-access">How to get Access</a></li> <li class="toctree-l2"><a class="reference internal" href="index.html#url-of-the-oai-endpoint">URL of the OAI Endpoint</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="index.html#oai-pmh-primer">OAI-PMH Primer</a><ul> <li class="toctree-l2"><a class="reference internal" href="index.html#glossary-of-important-oai-pmh-concepts">Glossary of Important OAI-PMH Concepts</a></li> <li class="toctree-l2"><a class="reference internal" href="index.html#oai-verbs">OAI Verbs</a></li> <li class="toctree-l2"><a class="reference internal" href="index.html#harvesting-records">Harvesting Records</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="index.html#metadata-formats">Metadata Formats</a><ul> <li class="toctree-l2"><a class="reference internal" href="index.html#oai-dc"><code class="docutils literal notranslate"><span class="pre">oai_dc</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="index.html#base-dc"><code class="docutils literal notranslate"><span class="pre">base_dc</span></code></a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="index.html#record-headers">Record Headers</a><ul> <li class="toctree-l2"><a class="reference internal" href="index.html#id1"><code class="docutils literal notranslate"><span class="pre">identifier</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="index.html#datestamp"><code class="docutils literal notranslate"><span class="pre">datestamp</span></code></a></li> <li class="toctree-l2"><a class="reference internal" href="index.html#deleted-records">Deleted Records</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="index.html#date-ranges">Date Ranges</a></li> <li class="toctree-l1"><a class="reference internal" href="index.html#dynamic-sets">Dynamic Sets</a></li> <li class="toctree-l1"><a class="reference internal" href="index.html#indexed-and-normalized-fields">Indexed and Normalized Fields</a><ul> <li class="toctree-l2"><a class="reference internal" href="index.html#overview-of-indexed-fields">Overview of Indexed Fields</a></li> <li class="toctree-l2"><a class="reference internal" href="index.html#document-types">Document Types</a></li> <li class="toctree-l2"><a class="reference internal" href="index.html#continents-and-countries">Continents and Countries</a></li> <li class="toctree-l2"><a class="reference internal" href="index.html#subject-classification">Subject Classification</a></li> <li class="toctree-l2"><a class="reference internal" href="index.html#open-access-status">Open Access Status</a></li> <li class="toctree-l2"><a class="reference internal" href="index.html#licensing-information">Licensing Information</a></li> </ul> </li> </ul> </div> </div> <div class="clearer"></div> </div> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="nav-item nav-item-0"><a href="index.html#document-index">BASE OAI Interface 3.2 documentation</a> &#187;</li> </ul> </div> <div class="footer"> &copy; Copyright 2020, Bielefeld University Library. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.8.6. <br />Theme based on <a href="http://readthedocs.org/">Read The Docs</a> </div> </body> </html>

Pages: 1 2 3 4 5 6 7 8 9 10