| 1 |
26607
|
alessia.ba
|
<?xml version="1.0" encoding="UTF-8"?>
|
| 2 |
|
|
<chapter version="5.0" xmlns="http://docbook.org/ns/docbook"
|
| 3 |
35362
|
alessia.ba
|
xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="cha_projects_http"
|
| 4 |
35524
|
alessia.ba
|
xreflabel="Bulk access to projects">
|
| 5 |
|
|
<title>Bulk access to projects</title>
|
| 6 |
35362
|
alessia.ba
|
<para>The APIs offer custom access to metadata about projects funded by a selection of
|
| 7 |
39230
|
alessia.ba
|
international funders for the DSpace and EPrints platforms.</para>
|
| 8 |
35524
|
alessia.ba
|
<para xml:id="fundings" xreflabel="Funding codes">The currently supported funding streams and
|
| 9 |
|
|
relative codes are: <itemizedlist>
|
| 10 |
35362
|
alessia.ba
|
<listitem>
|
| 11 |
|
|
<para>FP7: The 7th Framework Programme funded by the European Commission</para>
|
| 12 |
|
|
</listitem>
|
| 13 |
|
|
<listitem>
|
| 14 |
|
|
<para>WT: Wellcome Trust funding programme</para>
|
| 15 |
|
|
</listitem>
|
| 16 |
|
|
<listitem>
|
| 17 |
39230
|
alessia.ba
|
<para>H2020: Horizon2020 Programme funded by the European Commission</para>
|
| 18 |
35362
|
alessia.ba
|
</listitem>
|
| 19 |
|
|
<listitem>
|
| 20 |
|
|
<para>FCT: the funding programme of Fundação para a Ciência e a Tecnologia, the
|
| 21 |
|
|
national funding agency of Portugal</para>
|
| 22 |
|
|
</listitem>
|
| 23 |
39230
|
alessia.ba
|
<listitem>
|
| 24 |
|
|
<para>ARC: the funding programme of the Australian Research Council</para>
|
| 25 |
|
|
</listitem>
|
| 26 |
|
|
<listitem>
|
| 27 |
|
|
<para>NHMRC: the funding programme of the Australian National Health and Medical Research Council</para>
|
| 28 |
|
|
</listitem>
|
| 29 |
|
|
</itemizedlist> Coming soon: <itemizedlist>
|
| 30 |
|
|
<listitem>
|
| 31 |
|
|
<para>SFI: Science Foundation Ireland</para>
|
| 32 |
|
|
</listitem>
|
| 33 |
|
|
<listitem>
|
| 34 |
|
|
<para>CSF: Croatian Science Foundation</para>
|
| 35 |
|
|
</listitem>
|
| 36 |
|
|
<listitem>
|
| 37 |
|
|
<para>MSES: Ministry of Science, Education and Sports of the Republic of Croatia</para>
|
| 38 |
|
|
</listitem>
|
| 39 |
35362
|
alessia.ba
|
</itemizedlist>
|
| 40 |
|
|
</para>
|
| 41 |
35524
|
alessia.ba
|
<section>
|
| 42 |
|
|
<title>DSpace/ePrints</title>
|
| 43 |
|
|
<simplelist>
|
| 44 |
|
|
<member>DSpace endpoint: <link
|
| 45 |
|
|
xlink:href="http://api.openaire.eu/projects/dspace/$fundingStream/ALL/ALL"
|
| 46 |
35362
|
alessia.ba
|
/></member>
|
| 47 |
35524
|
alessia.ba
|
<member>ePrints endpoint: <link
|
| 48 |
|
|
xlink:href="http://api.openaire.eu/projects/eprints/$fundingStream/ALL/ALL"
|
| 49 |
|
|
/></member>
|
| 50 |
35362
|
alessia.ba
|
</simplelist>
|
| 51 |
35524
|
alessia.ba
|
<para> The URLs embed the parameters needed to collect projects funded by specific funding
|
| 52 |
|
|
stream, where the pattern is
|
| 53 |
|
|
<code>FundingStream/FundingSubStream/FundingSubSubStream</code>.</para>
|
| 54 |
|
|
<para>Additional parameters can be concatenated to the URL to refine the results by date
|
| 55 |
|
|
(date must be in the form <code>YYYY-MM-DD</code>): <simplelist>
|
| 56 |
|
|
<member>startFrom</member>
|
| 57 |
|
|
<member>startUntil</member>
|
| 58 |
|
|
<member>endFrom</member>
|
| 59 |
|
|
<member>endUntil</member>
|
| 60 |
|
|
</simplelist></para>
|
| 61 |
|
|
<para>Examples: <simplelist>
|
| 62 |
|
|
<member>Get Wellcome Trust projects for EPrints: <link
|
| 63 |
|
|
xlink:href="http://api.openaire.eu/projects/eprints/WT/ALL/ALL"/></member>
|
| 64 |
|
|
<member>Get EC-FP7 projects of the specific programme “SP2-IDEAS” for EPrints: <link
|
| 65 |
|
|
xlink:href="http://api.openaire.eu/projects/eprints/FP7/SP2/ALL"/></member>
|
| 66 |
|
|
<member>Get EC-FP7 projects for DSpace that started after the given date: <link
|
| 67 |
|
|
xlink:href="http://api.openaire.eu/projects/dspace/FP7/ALL/ALL?startFrom=2011-01-01"
|
| 68 |
|
|
/></member>
|
| 69 |
|
|
</simplelist>
|
| 70 |
|
|
</para>
|
| 71 |
|
|
</section>
|
| 72 |
39230
|
alessia.ba
|
<!--
|
| 73 |
35524
|
alessia.ba
|
<section>
|
| 74 |
|
|
<title>Projects in TSV file</title>
|
| 75 |
35526
|
alessia.ba
|
<para>Endpoint: <link xlink:href="http://api.openaire.eu/projects/tsv"/></para>
|
| 76 |
35524
|
alessia.ba
|
<para>Mandatory parameter: <simplelist>
|
| 77 |
|
|
<member>funding: the code of the funding program (See <xref linkend="fundings"
|
| 78 |
|
|
/>)</member>
|
| 79 |
|
|
</simplelist>
|
| 80 |
|
|
</para>
|
| 81 |
|
|
<para>Examples: <simplelist>
|
| 82 |
35526
|
alessia.ba
|
<member>Get Wellcome Trust projects in a tsv file: <link
|
| 83 |
|
|
xlink:href="http://api.openaire.eu/projects/tsv?funding=WT"
|
| 84 |
35524
|
alessia.ba
|
/></member>
|
| 85 |
|
|
</simplelist> The returned tsv file has an header where the semantics of each column is
|
| 86 |
|
|
described. </para>
|
| 87 |
|
|
</section>
|
| 88 |
39230
|
alessia.ba
|
-->
|
| 89 |
26607
|
alessia.ba
|
</chapter>
|