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

#690: HTTP API documentation for project and other updates. 

git-svn-id: https://svn.driver.research-infrastructures.eu/driver/dnet40/modules/dnet-api-http-doc/src@29511 d315682c-612b-4755-9ff5-7f18f6832af3
This commit is contained in:
Alessia Bardi 2014-07-24 14:09:49 +00:00
parent 6a29bf4dcc
commit a35cd2724b
9 changed files with 37 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docbkx/api-doc.xml
View File

@ -16,7 +16,7 @@
</author>
</authorgroup>
-->
<pubdate>6 June 2014</pubdate>
<pubdate>24 July 2014</pubdate>
</info>
<!-- include chapters -->

5
docbkx/http_api.xml
View File

@ -3,7 +3,7 @@
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
<para>The OpenAIRE+ HTTP API allows developers to access the metadata information space of OpenAIRE+ by
performing queries over publications, datasets, and projects.</para>
<para>The API is intended for metadata discovery and exploration only, that is it does not give direct access to publication files and it does not provide access
to the whole information space: the number of total results returned by one query is limited
@ -14,7 +14,6 @@
<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"/> -->
<xi:include href="sections/projects.xml"/>
</chapter>

5
docbkx/oai-pmh.xml
View File

@ -18,12 +18,13 @@
<member>projects: the set of all projects</member>
<member>FP7Projects: the set of projects funded by the EC Seventh Framework Programme</member>
<member>WTProjects: the set of projects funded by Wellcome Trust</member>
<member>organizations: the set of all organizations</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>
xlink:href="https://www.openaire.eu/schema/0.2/oaf-0.2.xsd">schema</link>, <link
xlink:href="https://www.openaire.eu/schema/0.2/doc/oaf-0.2.html">documentation</link>). </para>
<para>The availability of records in oai_dc depends on the typology of records. Currently
publications and datasets (records of type 'result') are available in oai_dc.</para>

15
docbkx/overview.xml
View File

@ -2,7 +2,7 @@
<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>
<para>The OpenAIRE API allows developers to access the metadata information space of OpenAIRE programmatically.</para>
<itemizedlist>
<listitem>
<para>Bulk access:</para>
@ -17,11 +17,20 @@
<simplelist>
<member><xref linkend="sec_http-pubs"/></member>
<member><xref linkend="sec_http-datasets"/></member>
<member>HTTP API for projects [available soon] </member>
<member><xref linkend="sec_http-projects"/></member>
<!-- <member>HTTP API for projects [available soon] </member> -->
</simplelist>
</listitem>
</itemizedlist>
<para>The default format of delivered records is <code>oaf</code> (OpenAire Format - current version 0.1):
<para>The default format of delivered records is <code>oaf</code> (OpenAire Format - current version 0.2):
<simplelist>
<member><link
xlink:href="https://www.openaire.eu/schema/0.2/oaf-0.2.xsd"><code>oaf</code> XML schema v0.2</link></member>
<member><link
xlink:href="https://www.openaire.eu/schema/0.2/doc/oaf-0.2.html"><code>oaf</code> XML schema v0.2 documentation</link></member>
</simplelist>
</para>
<para>Older versions:
<simplelist>
<member><link
xlink:href="https://www.openaire.eu/schema/0.1/oaf-0.1.xsd"><code>oaf</code> XML schema v0.1</link></member>

12
docbkx/projects-http.xml
View File

@ -3,14 +3,14 @@
xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="cha_projects_http"
xreflabel="FP7 projects export for DSpace and EPrints">
<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"
<para>The APIs offer custom access to FP7 and WT projects information for the DSpace and EPrints platforms:<simplelist>
<member>DSpace endpoint: <link xlink:href="http://api.openaire.eu/projects/dspace/$funder/ALL/ALL"
/></member>
<member>ePrints endpoint: <link
xlink:href="http://api.openaire.eu/projects/eprints/FP7/ALL/ALL"/></member>
xlink:href="http://api.openaire.eu/projects/eprints/$funder/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>
pattern is <code>Funder/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>
@ -20,7 +20,9 @@
</simplelist></para>
<para>Examples: <simplelist>
<member>Get projects of the specific programme “SP2-IDEAS” for EPrints: <link
<member>Get WT projects EPrints: <link
xlink:href="http://api.openaire.eu/projects/eprints/WT/ALL/ALL"/></member>
<member>Get FP7 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"

11
docbkx/sections/common_param.xml
View File

@ -12,13 +12,18 @@
the API.</para>
-->
<variablelist>
<!-- TODO: Uncomment when implemented/available -->
<!--
<varlistentry>
<term>page</term>
<listitem><para>Page number of the search results.</para></listitem>
</varlistentry>
<varlistentry>
<term>size</term>
<listitem><para>Number of results per page.</para></listitem>
</varlistentry>
<varlistentry>
<term>format</term>
<listitem><para>Options:<command>json | xml</command></para><para>Select the format of the response. Default is <command>xml</command>.</para></listitem>
</varlistentry>
-->
<!-- TODO: Uncomment when implemented/available -->
<!--
<varlistentry>

2
docbkx/sections/datasets.xml
View File

@ -10,7 +10,7 @@
<varlistentry>
<term>doi</term>
<listitem>
<para>Gets the dataset with the given doi, if any.</para>
<para>Allowed values: comma separated list of DOIs.Gets the datasets with the given DOIs, if any.</para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>

14
docbkx/sections/projects.xml
View File

@ -11,63 +11,53 @@
<term>grantID</term>
<listitem>
<para>Gets the project with the given grant identifier, if any.</para>
<para><code>here goes the sample query</code></para>
</listitem>
</varlistentry>
<varlistentry>
<term>name</term>
<listitem>
<para>Allowed values: white-space separated list of keywords. Gets the projects whose names contain the given list of keywords. </para>
<para><code>here goes the sample query</code></para>
</listitem>
</varlistentry>
<varlistentry>
<term>acronym</term>
<listitem>
<para>Gets the project with the given acronym, if any. </para>
<para><code>here goes the sample query</code></para>
</listitem>
<para>Gets the project with the given acronym, if any. </para></listitem>
</varlistentry>
<varlistentry>
<term>callID</term>
<listitem>
<para>Search for projects by call identifier.</para>
<para><code>here goes the sample query</code></para>
</listitem>
</varlistentry>
<varlistentry>
<term>keywords</term>
<listitem>
<para>Allowed values: white-space separated list of keywords. Search for projects whose name, title, description or keywords match the given terms. </para>
<para><code>here goes the sample query</code></para>
</listitem>
</varlistentry>
<varlistentry>
<term>startYear</term>
<listitem>
<para>Allowed values: year formatted as <code>YYYY</code>. Gets the projects that started in the given year. </para>
<para><code>here goes the sample query</code></para>
</listitem>
</varlistentry>
<varlistentry>
<term>endYear</term>
<listitem>
<para>Allowed values: year formatted as <code>YYYY</code>. Gets the projects that ended in the given year. </para>
<para><code>here goes the sample query</code></para>
</listitem>
</varlistentry>
<varlistentry>
<term>participantCountries</term>
<listitem>
<para>Allowed values: white space separeted list of country codes in ISOXXX. Search for projects by participant countries. </para>
<para><code>here goes the sample query</code></para>
<para>Allowed values: comma separeted list of 2 letter country codes. Search for projects by participant countries. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>participantAcronyms</term>
<listitem>
<para>Allowed values: white space separeted list of acronyms of institutions. Search for projects by participant institutions. </para>
<para><code>here goes the sample query</code></para>
</listitem>
</varlistentry>
</variablelist>

2
docbkx/sections/publications.xml
View File

@ -10,7 +10,7 @@
<varlistentry>
<term>doi</term>
<listitem>
<para>Gets the publication with the given doi, if any.</para>
<para>Allowed values: comma separated list of DOIs.Gets the publications with the given DOIs, if any.</para>
<!--<para><code>here goes the sample query</code></para> -->
</listitem>
</varlistentry>