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