OpenAIRE
/
openaire-api-http-doc
9
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ticket #300: updated doc for APIs 

git-svn-id: https://svn.driver.research-infrastructures.eu/driver/dnet30/modules/dnet-api-http-doc/src@26429 d315682c-612b-4755-9ff5-7f18f6832af3
This commit is contained in:
Alessia Bardi 2014-04-08 12:55:01 +00:00
parent ebe26da129
commit e30415da86
11 changed files with 240 additions and 134 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docbkx/book.xml
View File

@ -2,7 +2,8 @@
<book version="5.0" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:db="http://docbook.org/ns/docbook">
<info>
<title>OpenAIRE+ HTTP API documentation</title>
<title>OpenAIRE API documentation</title>
<!--
<authorgroup>
<author>
<personname>Alessia Bardi</personname>
@ -14,12 +15,18 @@
</affiliation>
</author>
</authorgroup>
<pubdate>10 Mar 2014</pubdate>
-->
<pubdate>8 April 2014</pubdate>
</info>
<!-- include chapters -->
<xi:include href="overview.xml"/>
<xi:include href="oai-pmh.xml"/>
<xi:include href="projects-http.xml"/>
<xi:include href="http_api.xml"/>
<!--
<xi:include href="intro_chapter.xml"/>
<xi:include href="param_chapter.xml"/>
-->
</book>

20
docbkx/intro_chapter.xml → docbkx/http_api.xml
View File

@ -1,16 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter version="5.0" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Introduction</title>
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="cha_http-api" xreflabel="HTTP Search API">
<title>Selective access with HTTP API</title>
<para>The OpenAIRE+ HTTP API allows developers to access the information space of OpenAIRE+ by
performing queries over publications, datasets, and projects.</para>
<para>The API is intended for discovery and exploration only, that is it does not provide access
to the whole informaton space, but the number of total results returned by one query is limited
to 1000.</para>
<para>For accessing the whole information space, developers are encouraged to use the OAI-PMH API
available at <link xlink:href="http://api.openaire.eu/oai_pmh"/>. For details on the OAI-PMH
protocol please refer to the official documentation at <link
xlink:href="http://www.openarchives.org/OAI/openarchivesprotocol.html"/>
</para>
<para>For accessing the whole information space, developers are encouraged to use the <xref
linkend="cha_oai_pmh"/></para>
<xi:include href="sections/common_param.xml"/>
<xi:include href="sections/publications.xml"/>
<xi:include href="sections/datasets.xml"/>
<!-- TODO: uncomment the following when API for projects are ready -->
<!--<xi:include href="sections/projects.xml"/> -->
</chapter>

29
docbkx/oai-pmh.xml Normal file
View File

@ -0,0 +1,29 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter version="5.0" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="cha_oai_pmh" xreflabel="OAI-PMH">
<title>Bulk access via OAI-PMH</title>
<para>OAI-PMH is a standard protocol for metadata publishing and harvesting. For details on the
OAI-PMH protocol please refer to the official documentation at <link
xlink:href="http://www.openarchives.org/OAI/openarchivesprotocol.html"/></para>
<para>The OpenAIRE OAI-PMH endpoint is <link xlink:href="http://api.openaire.eu/oai_pmh"/></para>
<para>For information about the endpoint check <link
xlink:href="http://api.openaire.eu/oai_pmh?verb=Identify"/></para>
<para>The updated list of OAI sets is always available at: <link
xlink:href="http://api.openaire.eu/oai_pmh?verb=ListSets"/></para>
<para>For quick reference, we report here the likely more interesting sets:</para>
<simplelist>
<member>publications: the set of all publications</member>
<member>OpenAccess: the set of all Open Access publications and datasets</member>
<member>projects: the set of all projects</member>
<member>organizations: the set of all organizations</member>
<member>datasets: the set of all datasets</member>
</simplelist>
<para>For the list of available metadata prefix, check: <link
xlink:href="http://api.openaire.eu/oai_pmh?verb=ListMetadataFormats"/>.</para>
<para>Note that records will always be available in the OpenAIRE format (<link
xlink:href="https://www.openaire.eu/schema/0.1/oaf-0.1.xsd">schema</link>, <link
xlink:href="https://www.openaire.eu/schema/0.1/doc/oaf-0.1.html">documentation</link>). </para>
<para>The availability of records in oai_dc depends on the typology of records. Currently only
publications and datasets (records of type 'result') are available in oai_dc.</para>
</chapter>

165
docbkx/out/html/book.html
View File

@ -1,32 +1,61 @@
<html><head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>OpenAIRE+ HTTP API documentation</title><link rel="stylesheet" href="/Users/alessia/workspace/dnet/openaire/dnet-api-http-doc/src/docbkx/openaire-api.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" title="OpenAIRE+ HTTP API documentation"><div class="titlepage"><div><div><h1 class="title"><a name="d4e1"></a>OpenAIRE+ HTTP API documentation</h1></div><div><div class="authorgroup">
<div class="author"><h3 class="author">Alessia Bardi</h3><div class="affiliation">
<span class="org">
<span class="orgname">ISTI-CNR</span>
</span>
</div><code class="email">&lt;<a class="email" href="mailto:alessia.bardi@isti.cnr.it">alessia.bardi@isti.cnr.it</a>&gt;</code></div>
</div></div><div><p class="pubdate">10 Mar 2014</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#d4e12">1. Introduction</a></span></dt><dt><span class="chapter"><a href="#d4e19">2. API parameters</a></span></dt><dd><dl><dt><span class="section"><a href="#d4e21">Common API parameters</a></span></dt><dt><span class="section"><a href="#d4e65">Publications</a></span></dt><dt><span class="section"><a href="#d4e140">Datasets</a></span></dt><dt><span class="section"><a href="#d4e215">Projects</a></span></dt></dl></dd></dl></div>
<title>OpenAIRE API documentation</title><link rel="stylesheet" href="/Users/alessia/workspace/dnet/openaire/dnet-api-http-doc/src/docbkx/openaire-api.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" title="OpenAIRE API documentation"><div class="titlepage"><div><div><h1 class="title"><a name="d4e1"></a>OpenAIRE API documentation</h1></div><div><p class="pubdate">8 April 2014</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#d4e5">1. Overview</a></span></dt><dt><span class="chapter"><a href="#cha_oai_pmh">2. Bulk access via OAI-PMH</a></span></dt><dt><span class="chapter"><a href="#cha_projects_http">3. Bulk access to FP7 projects</a></span></dt><dt><span class="chapter"><a href="#cha_http-api">4. Selective access with HTTP API</a></span></dt><dd><dl><dt><span class="section"><a href="#sec_http-common">Common API parameters</a></span></dt><dt><span class="section"><a href="#sec_http-pubs">Publications</a></span></dt><dt><span class="section"><a href="#sec_http-datasets">Datasets</a></span></dt></dl></dd></dl></div>
<div class="chapter" title="Chapter&nbsp;1.&nbsp;Overview"><div class="titlepage"><div><div><h2 class="title"><a name="d4e5"></a>Chapter&nbsp;1.&nbsp;Overview</h2></div></div></div>
<p>The OpenAIRE API allows developers to access the information space of OpenAIRE programmatically.</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
<p>Bulk access:</p>
<table border="0" summary="Simple list" class="simplelist"><tr><td><a class="xref" href="#cha_oai_pmh" title="Chapter&nbsp;2.&nbsp;Bulk access via OAI-PMH">OAI-PMH</a></td></tr><tr><td><a class="xref" href="#cha_projects_http" title="Chapter&nbsp;3.&nbsp;Bulk access to FP7 projects">FP7 projects export</a></td></tr></table>
</li><li class="listitem">
<p>Selective access via <a class="xref" href="#cha_http-api" title="Chapter&nbsp;4.&nbsp;Selective access with HTTP API">HTTP Search API</a></p>
<table border="0" summary="Simple list" class="simplelist"><tr><td><a class="xref" href="#sec_http-pubs" title="Publications">Search HTTP API for publications</a></td></tr><tr><td><a class="xref" href="#sec_http-datasets" title="Datasets">Search HTTP API for datasets</a></td></tr><tr><td>HTTP API for projects [available soon] </td></tr></table>
</li></ul></div>
<div class="chapter" title="Chapter&nbsp;1.&nbsp;Introduction"><div class="titlepage"><div><div><h2 class="title"><a name="d4e12"></a>Chapter&nbsp;1.&nbsp;Introduction</h2></div></div></div>
</div>
<div class="chapter" title="Chapter&nbsp;2.&nbsp;Bulk access via OAI-PMH"><div class="titlepage"><div><div><h2 class="title"><a name="cha_oai_pmh"></a>Chapter&nbsp;2.&nbsp;Bulk access via OAI-PMH</h2></div></div></div>
<p>OAI-PMH is a standard protocol for metadata publishing and harvesting. For details on the
OAI-PMH protocol please refer to the official documentation at <a class="ulink" href="http://www.openarchives.org/OAI/openarchivesprotocol.html" target="_top">http://www.openarchives.org/OAI/openarchivesprotocol.html</a></p>
<p>The OpenAIRE OAI-PMH endpoint is <a class="ulink" href="http://api.openaire.eu/oai_pmh" target="_top">http://api.openaire.eu/oai_pmh</a></p>
<p>For information about the endpoint check <a class="ulink" href="http://api.openaire.eu/oai_pmh?verb=Identify" target="_top">http://api.openaire.eu/oai_pmh?verb=Identify</a></p>
<p>The updated list of OAI sets is always available at: <a class="ulink" href="http://api.openaire.eu/oai_pmh?verb=ListSets" target="_top">http://api.openaire.eu/oai_pmh?verb=ListSets</a></p>
<p>For quick reference, we report here the likely more interesting sets:</p>
<table border="0" summary="Simple list" class="simplelist"><tr><td>publications: the set of all publications</td></tr><tr><td>OpenAccess: the set of all Open Access publications and datasets</td></tr><tr><td>projects: the set of all projects</td></tr><tr><td>organizations: the set of all organizations</td></tr><tr><td>datasets: the set of all datasets</td></tr></table>
<p>For the list of available metadata prefix, check: <a class="ulink" href="http://api.openaire.eu/oai_pmh?verb=ListMetadataFormats" target="_top">http://api.openaire.eu/oai_pmh?verb=ListMetadataFormats</a>.</p>
<p>Note that records will always be available in the OpenAIRE format (<a class="ulink" href="https://www.openaire.eu/schema/0.1/oaf-0.1.xsd" target="_top">schema</a>, <a class="ulink" href="https://www.openaire.eu/schema/0.1/doc/oaf-0.1.html" target="_top">documentation</a>). </p>
<p>The availability of records in oai_dc depends on the typology of records. Currently only
publications and datasets (records of type 'result') are available in oai_dc.</p>
</div>
<div class="chapter" title="Chapter&nbsp;3.&nbsp;Bulk access to FP7 projects"><div class="titlepage"><div><div><h2 class="title"><a name="cha_projects_http"></a>Chapter&nbsp;3.&nbsp;Bulk access to FP7 projects</h2></div></div></div>
<p>The APIs offer custom access to EC projects information for the DSpace and EPrints platforms:</p><table border="0" summary="Simple list" class="simplelist"><tr><td>DSpace endpoint: <a class="ulink" href="http://api.openaire.eu/projects/dspace/FP7/ALL/ALL" target="_top">http://api.openaire.eu/projects/dspace/FP7/ALL/ALL</a></td></tr><tr><td>ePrints endpoint: <a class="ulink" href="http://api.openaire.eu/projects/eprints/FP7/ALL/ALL" target="_top">http://api.openaire.eu/projects/eprints/FP7/ALL/ALL</a></td></tr></table>
<p> The URLs embed the parameters needed to collect sub-portions of the EC projects, where the
pattern is <code class="code">FP7/SpecificProgramme/ScientificArea</code>.</p>
<p>Additional parameters can be concatenated to the URL to refine the results by date (date
must be in the form <code class="code">YYYY-MM-DD</code>): </p><table border="0" summary="Simple list" class="simplelist"><tr><td>startFrom</td></tr><tr><td>startUntil</td></tr><tr><td>endFrom</td></tr><tr><td>endUntil</td></tr></table>
<p>Examples: </p><table border="0" summary="Simple list" class="simplelist"><tr><td>Get projects of the specific programme &#8220;SP2-IDEAS&#8221; for Eprints: <a class="ulink" href="http://api.openaire.eu/projects/eprints/FP7/SP2/ALL" target="_top">http://api.openaire.eu/projects/eprints/FP7/SP2/ALL</a></td></tr><tr><td>Get FP7 projects for Dspace that started after the given date: <a class="ulink" href="http://api.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01" target="_top">http://api.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01</a></td></tr></table><p>
</p>
</div>
<div class="chapter" title="Chapter&nbsp;4.&nbsp;Selective access with HTTP API"><div class="titlepage"><div><div><h2 class="title"><a name="cha_http-api"></a>Chapter&nbsp;4.&nbsp;Selective access with HTTP API</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#sec_http-common">Common API parameters</a></span></dt><dt><span class="section"><a href="#sec_http-pubs">Publications</a></span></dt><dt><span class="section"><a href="#sec_http-datasets">Datasets</a></span></dt></dl></div>
<p>The OpenAIRE+ HTTP API allows developers to access the information space of OpenAIRE+ by
performing queries over publications, datasets, and projects.</p>
<p>The API is intended for discovery and exploration only, that is it does not provide access
to the whole informaton space, but the number of total results returned by one query is limited
to 1000.</p>
<p>For accessing the whole information space, developers are encouraged to use the OAI-PMH API
available at <a class="ulink" href="http://api.openaire.eu/oai_pmh" target="_top">http://api.openaire.eu/oai_pmh</a>. For details on the OAI-PMH
protocol please refer to the official documentation at <a class="ulink" href="http://www.openarchives.org/OAI/openarchivesprotocol.html" target="_top">http://www.openarchives.org/OAI/openarchivesprotocol.html</a>
</p>
</div>
<div class="chapter" title="Chapter&nbsp;2.&nbsp;API parameters"><div class="titlepage"><div><div><h2 class="title"><a name="d4e19"></a>Chapter&nbsp;2.&nbsp;API parameters</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#d4e21">Common API parameters</a></span></dt><dt><span class="section"><a href="#d4e65">Publications</a></span></dt><dt><span class="section"><a href="#d4e140">Datasets</a></span></dt><dt><span class="section"><a href="#d4e215">Projects</a></span></dt></dl></div>
<div class="section" title="Common API parameters"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d4e21"></a>Common API parameters</h2></div></div></div>
<p>For accessing the whole information space, developers are encouraged to use the <a class="xref" href="#cha_oai_pmh" title="Chapter&nbsp;2.&nbsp;Bulk access via OAI-PMH">OAI-PMH</a></p>
<div class="section" title="Common API parameters"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sec_http-common"></a>Common API parameters</h2></div></div></div>
<p> Parameters included in this section can always be specified, regardless the type of
entities (publications, datasets, or projects) you want to retrieve. </p>
@ -39,24 +68,24 @@
<p>Allowed values: <code class="code">true|false</code>. If hasECFunding is true gets the publications/datasets/projects
funded by the EC. If hasECFunding is false gets the publications/datasets/projects
related to projects not funded by the EC. </p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">hasUKFunding</span></dt><dd>
<p>Allowed values: <code class="code">true|false</code>.If hasUKFunding is true gets the publications/datasets/projects
funded by the UK. If hasUKFunding is false gets the publications/datasets/projects
related to projects not funded by the UK.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">funder</span></dt><dd>
<p>Allowed values: <code class="code">wt|fp7|h2020</code>. Search for publications/datasets/projects by funder.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">fundingStream</span></dt><dd>
<p>Allowed values: ?. Search for publications/datasets/projects by funding stream.</p>
<p><code class="code">here goes the sample query</code></p>
<p>earch for publications/datasets/projects by funding stream.</p>
</dd><dt><span class="term">FP7scientificArea</span></dt><dd>
<p>Allowed values: ?. Search for FP7 publications/datasets/projects by scientific area. </p>
<p><code class="code">here goes the sample query</code></p>
<p>Search for FP7 publications/datasets/projects by scientific area. </p>
</dd></dl></div>
</div>
<div class="section" title="Publications"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d4e65"></a>Publications</h2></div></div></div>
<div class="section" title="Publications"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sec_http-pubs"></a>Publications</h2></div></div></div>
<p>Endpoint: <code class="code">http://api.openaire.eu/search/publications</code></p>
@ -64,46 +93,49 @@
<div class="variablelist"><dl><dt><span class="term">doi</span></dt><dd>
<p>Gets the publication with the given doi, if any.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">openairePublicationID</span></dt><dd>
<p>Gets the publication with the given openaire identifier, if any.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">fromDateAccepted</span></dt><dd>
<p>Allowed values: date formatted as <code class="code">YYYY-MM-DD</code>. Gets the publications whose date of acceptance is greater than or equal the given
date.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">toDateAccepted</span></dt><dd>
<p>Allowed values: date formatted as <code class="code">YYYY-MM-DD</code>. Gets the publications whose date of acceptance is less than or equal the given date.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">title</span></dt><dd>
<p>Allowed values: white-space separated list of keywords. Gets the publications whose titles contain the given list of keywords.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">author</span></dt><dd>
<p>Search for publications by authors. Allowed value is a white-space separated list of
names and/or surnames.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">openaireAuthorID</span></dt><dd>
<p>Search for publications by openaire author identifier.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">openaireProviderID</span></dt><dd>
<p>Search for publications by openaire data provider identifier.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">openaireProjectID</span></dt><dd>
<p>Search for publications by openaire project identifier.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">hasProject</span></dt><dd>
<p>Allowed values: <code class="code">true|false</code>. If hasProject is true gets the publications
that have a link to a project. If hasProject is false gets the publications with no links
to projects.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">FP7ProjectID</span></dt><dd>
<p>Search for publications associated to a FP7 project with the given grant number.</p>
</dd><dt><span class="term">OA</span></dt><dd>
<p>Allowed values: <code class="code">true|false</code>. If OA is true gets Open Access publications.
If OA is false gets the non Open Access publications</p>
<p><code class="code">here goes the sample query</code></p>
</dd></dl></div>
</div>
<div class="section" title="Datasets"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d4e140"></a>Datasets</h2></div></div></div>
<div class="section" title="Datasets"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="sec_http-datasets"></a>Datasets</h2></div></div></div>
<p>Endpoint: <code class="code">http://api.openaire.eu/search/datasets</code></p>
@ -111,82 +143,53 @@
<div class="variablelist"><dl><dt><span class="term">doi</span></dt><dd>
<p>Gets the dataset with the given doi, if any.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">openaireDatasetID</span></dt><dd>
<p>Gets the dataset with the given openaire identifier, if any.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">fromDateCollected</span></dt><dd>
<p>Allowed values: date formatted as <code class="code">YYYY-MM-DD</code>. Gets the datasets whose date of acceptance is greater than or equal the given
date.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">toDateCollected</span></dt><dd>
<p>Allowed values: date formatted as <code class="code">YYYY-MM-DD</code>. Gets the datasets whose date of acceptance is less than or equal the given date.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">title</span></dt><dd>
<p>Gets the datasets whose titles contain the given list of keywords. Allowed value
is a white-space separated list of keywords.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">author</span></dt><dd>
<p>Search for datasets by authors. Allowed value is a white-space separated list of
names and/or surnames.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">openaireAuthorID</span></dt><dd>
<p>Search for datasets by openaire author identifier.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">openaireProviderID</span></dt><dd>
<p>Search for datasets by openaire data provider identifier.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">openaireProjectID</span></dt><dd>
<p>Search for datasets by openaire project identifier.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">hasProject</span></dt><dd>
<p>Allowed values: <code class="code">true|false</code>. If hasProject is true gets the datasets
that have a link to a project. If hasProject is false gets the datasets with no links
to projects.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">FP7ProjectID</span></dt><dd>
<p>Search for datasets associated to a FP7 project with the given grant number.</p>
</dd><dt><span class="term">OA</span></dt><dd>
<p>Allowed values: <code class="code">true|false</code>. If OA is true gets Open Access datasets.
If OA is false gets the non Open Access datasets</p>
<p><code class="code">here goes the sample query</code></p>
</dd></dl></div>
</div>
<div class="section" title="Projects"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d4e215"></a>Projects</h2></div></div></div>
<p>Endpoint: <code class="code">http://api.openaire.eu/search/projects</code></p>
<div class="variablelist"><dl><dt><span class="term">grantID</span></dt><dd>
<p>Gets the project with the given grant identifier, if any.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">name</span></dt><dd>
<p>Allowed values: white-space separated list of keywords. Gets the projects whose names contain the given list of keywords. </p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">acronym</span></dt><dd>
<p>Gets the project with the given acronym, if any. </p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">callID</span></dt><dd>
<p>Search for projects by call identifier.</p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">keywords</span></dt><dd>
<p>Allowed values: white-space separated list of keywords. Search for projects whose name, title, description or keywords match the given terms. </p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">startYear</span></dt><dd>
<p>Allowed values: year formatted as <code class="code">YYYY</code>. Gets the projects that started in the given year. </p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">endYear</span></dt><dd>
<p>Allowed values: year formatted as <code class="code">YYYY</code>. Gets the projects that ended in the given year. </p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">participantCountries</span></dt><dd>
<p>Allowed values: white space separeted list of country codes in ISOXXX. Search for projects by participant countries. </p>
<p><code class="code">here goes the sample query</code></p>
</dd><dt><span class="term">participantAcronyms</span></dt><dd>
<p>Allowed values: white space separeted list of acronyms of institutions. Search for projects by participant institutions. </p>
<p><code class="code">here goes the sample query</code></p>
</dd></dl></div>
</div>
</div>
</div></body></html>

26
docbkx/overview.xml Normal file
View File

@ -0,0 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter version="5.0" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Overview</title>
<para>The OpenAIRE API allows developers to access the information space of OpenAIRE programmatically.</para>
<itemizedlist>
<listitem>
<para>Bulk access:</para>
<simplelist>
<member><xref linkend="cha_oai_pmh"/></member>
<member><xref linkend="cha_projects_http"/></member>
</simplelist>
</listitem>
<listitem>
<para>Selective access via <xref linkend="cha_http-api"/></para>
<simplelist>
<member><xref linkend="sec_http-pubs"/></member>
<member><xref linkend="sec_http-datasets"/></member>
<member>HTTP API for projects [available soon] </member>
</simplelist>
</listitem>
</itemizedlist>
</chapter>

9
docbkx/param_chapter.xml
View File

@ -1,9 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter version="5.0" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>API parameters</title>
<xi:include href="sections/common_param.xml"/>
<xi:include href="sections/publications.xml"/>
<xi:include href="sections/datasets.xml"/>
<xi:include href="sections/projects.xml"/>
</chapter>

32
docbkx/projects-http.xml Normal file
View File

@ -0,0 +1,32 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter version="5.0" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="cha_projects_http"
xreflabel="FP7 projects export">
<title>Bulk access to FP7 projects</title>
<para>The APIs offer custom access to EC projects information for the DSpace and EPrints platforms:<simplelist>
<member>DSpace endpoint: <link xlink:href="http://api.openaire.eu/projects/dspace/FP7/ALL/ALL"
/></member>
<member>ePrints endpoint: <link
xlink:href="http://api.openaire.eu/projects/eprints/FP7/ALL/ALL"/></member>
</simplelist></para>
<para> The URLs embed the parameters needed to collect sub-portions of the EC projects, where the
pattern is <code>FP7/SpecificProgramme/ScientificArea</code>.</para>
<para>Additional parameters can be concatenated to the URL to refine the results by date (date
must be in the form <code>YYYY-MM-DD</code>): <simplelist>
<member>startFrom</member>
<member>startUntil</member>
<member>endFrom</member>
<member>endUntil</member>
</simplelist></para>
<para>Examples: <simplelist>
<member>Get projects of the specific programme “SP2-IDEAS” for Eprints: <link
xlink:href="http://api.openaire.eu/projects/eprints/FP7/SP2/ALL"/></member>
<member>Get FP7 projects for Dspace that started after the given date: <link
xlink:href="http://api.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01"
/></member>
</simplelist>
</para>
</chapter>

16
docbkx/sections/common_param.xml
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<section version="5.0" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec_http-common">
<title>Common API parameters</title>
<para> Parameters included in this section can always be specified, regardless the type of
entities (publications, datasets, or projects) you want to retrieve. </para>
@ -37,7 +37,7 @@
<para>Allowed values: <code>true|false</code>. If hasECFunding is true gets the publications/datasets/projects
funded by the EC. If hasECFunding is false gets the publications/datasets/projects
related to projects not funded by the EC. </para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
@ -46,28 +46,28 @@
<para>Allowed values: <code>true|false</code>.If hasUKFunding is true gets the publications/datasets/projects
funded by the UK. If hasUKFunding is false gets the publications/datasets/projects
related to projects not funded by the UK.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
<term>funder</term>
<listitem>
<para>Allowed values: <code>wt|fp7|h2020</code>. Search for publications/datasets/projects by funder.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
<term>fundingStream</term>
<listitem>
<para>Allowed values: ?. Search for publications/datasets/projects by funding stream.</para>
<para><code>here goes the sample query</code></para>
<para>earch for publications/datasets/projects by funding stream.</para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
<term>FP7scientificArea</term>
<listitem>
<para>Allowed values: ?. Search for FP7 publications/datasets/projects by scientific area. </para>
<para><code>here goes the sample query</code></para>
<para>Search for FP7 publications/datasets/projects by scientific area. </para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
</variablelist>

31
docbkx/sections/datasets.xml
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<section version="5.0" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec_http-datasets" xreflabel="Search HTTP API for datasets">
<title>Datasets</title>
<para>Endpoint: <code>http://api.openaire.eu/search/datasets</code></para>
<!-- TODO: uncomment when the API version feature is implemented -->
@ -11,14 +11,14 @@
<term>doi</term>
<listitem>
<para>Gets the dataset with the given doi, if any.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
<term>openaireDatasetID</term>
<listitem>
<para>Gets the dataset with the given openaire identifier, if any.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
@ -26,14 +26,14 @@
<listitem>
<para>Allowed values: date formatted as <code>YYYY-MM-DD</code>. Gets the datasets whose date of acceptance is greater than or equal the given
date.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
<term>toDateCollected</term>
<listitem>
<para>Allowed values: date formatted as <code>YYYY-MM-DD</code>. Gets the datasets whose date of acceptance is less than or equal the given date.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
@ -41,7 +41,7 @@
<listitem>
<para>Gets the datasets whose titles contain the given list of keywords. Allowed value
is a white-space separated list of keywords.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
@ -49,28 +49,28 @@
<listitem>
<para>Search for datasets by authors. Allowed value is a white-space separated list of
names and/or surnames.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
<term>openaireAuthorID</term>
<listitem>
<para>Search for datasets by openaire author identifier.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
<term>openaireProviderID</term>
<listitem>
<para>Search for datasets by openaire data provider identifier.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
<term>openaireProjectID</term>
<listitem>
<para>Search for datasets by openaire project identifier.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
@ -79,7 +79,14 @@
<para>Allowed values: <code>true|false</code>. If hasProject is true gets the datasets
that have a link to a project. If hasProject is false gets the datasets with no links
to projects.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
<term>FP7ProjectID</term>
<listitem>
<para>Search for datasets associated to a FP7 project with the given grant number.</para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
@ -87,7 +94,7 @@
<listitem>
<para>Allowed values: <code>true|false</code>. If OA is true gets Open Access datasets.
If OA is false gets the non Open Access datasets</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
</variablelist>

2
docbkx/sections/projects.xml
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<section version="5.0" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec_http-projects" xreflabel="Search HTTP API for projects">
<title>Projects</title>
<para>Endpoint: <code>http://api.openaire.eu/search/projects</code></para>
<!-- TODO: uncomment when the API version feature is implemented -->

31
docbkx/sections/publications.xml
View File

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<section version="5.0" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="sec_http-pubs" xreflabel="Search HTTP API for publications">
<title>Publications</title>
<para>Endpoint: <code>http://api.openaire.eu/search/publications</code></para>
<!-- TODO: uncomment when the API version feature is implemented -->
@ -11,14 +11,14 @@
<term>doi</term>
<listitem>
<para>Gets the publication with the given doi, if any.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
<term>openairePublicationID</term>
<listitem>
<para>Gets the publication with the given openaire identifier, if any.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
@ -26,21 +26,21 @@
<listitem>
<para>Allowed values: date formatted as <code>YYYY-MM-DD</code>. Gets the publications whose date of acceptance is greater than or equal the given
date.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
<term>toDateAccepted</term>
<listitem>
<para>Allowed values: date formatted as <code>YYYY-MM-DD</code>. Gets the publications whose date of acceptance is less than or equal the given date.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
<term>title</term>
<listitem>
<para>Allowed values: white-space separated list of keywords. Gets the publications whose titles contain the given list of keywords.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
@ -48,28 +48,28 @@
<listitem>
<para>Search for publications by authors. Allowed value is a white-space separated list of
names and/or surnames.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
<term>openaireAuthorID</term>
<listitem>
<para>Search for publications by openaire author identifier.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
<term>openaireProviderID</term>
<listitem>
<para>Search for publications by openaire data provider identifier.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
<term>openaireProjectID</term>
<listitem>
<para>Search for publications by openaire project identifier.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
@ -78,7 +78,14 @@
<para>Allowed values: <code>true|false</code>. If hasProject is true gets the publications
that have a link to a project. If hasProject is false gets the publications with no links
to projects.</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
<term>FP7ProjectID</term>
<listitem>
<para>Search for publications associated to a FP7 project with the given grant number.</para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
<varlistentry>
@ -86,7 +93,7 @@
<listitem>
<para>Allowed values: <code>true|false</code>. If OA is true gets Open Access publications.
If OA is false gets the non Open Access publications</para>
<para><code>here goes the sample query</code></para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>
</variablelist>