Research & Innovation - Participant Portal

Search

Participant Portal Application Programming Interfaces (APIs)

1. Introduction

This page provides a description of the external interfaces exposed by the Participant Portal for use by third party systems.

This service currently runs in pilot mode, but may undergo modications and future service enhancement.

Participant Portal web services are available in JSON format.

2. Which Participant Portal web services are available?

The following Participant Portal services are available for external systems:

3. How to use Participant Portal web services?

Participant Portal Web Services provide structured information for use by external systems in the form of JSON files.

As an example, the JSON files can be integrated into the third party web-sites to display the following:

  • Calls and topics for a given programme with opening dates and deadlines,
  • Links to call and topic pages in the Participant Portal,
  • Latest news on calls and topics for a given programme.

Available services are dynamic, ensuring up-to-date information is always available. More precisely, whenever the new call, topic or call update is introduced or modified in the Participant Portal, web services automatically display this information.

4. What is JSON format?

JSON (JavaScript Object Notation) is an open standard format that uses human-readable text to transmit data objects consisting of attribute–value pairs. It is the language independent data format used for asynchronous browser/server communication.

JSON files can be integrated into web page or application by use of JSON parsers.

5. Calls service [Back To Top]

The Calls service provides the list of all calls per programme, with related metadata.

5.1. Uniform Resource Locator (URL)

The Calls service is available per programme under the following locations:

5.2. Structure

Calls service has the following structure:

{
"callData":{
                     "Calls":[ { call1 }, { call2 }, { call3 }, { ... } ]
                }
}

5.3. Description


Object {} /List [] /Attribute

Type

Description

callData {}

Calls []

List of all calls for a given programme.

CallIdentifier {}

Object which provides information on the call.

FileName

String

Name of the call page (html file) in the Participant Portal.

CallId

String

Call identifier.

hasForthcomingTopics

Boolean

Provides information if the call contains forthcoming topics.

hasOpenTopics

Boolean

Provides information if the call contains open topics.

allClosedTopics

Boolean

Provides information if the call contains only closed topics.

Title

String

Call title.

FrameworkProgramme

String

Programme to which the call belongs to.

WPpart

String

Title of that part of work programme to which the call belongs.

CallBudgetOverview []

Overview of a complete budget of a call.

Budget {}

Budget component of a call. One call might have several budget components.

Topic

String

Topic covered by the corresponding budget component. There might be several topics within one budget component.

Year

Date

Year of a budget component.

Amount

Long

Budget amount of a budget component.

Stages

String

Deadline model of a budget component.

Opening date

Date

Opening date of all topics within a budget component.

Deadline

Date

Deadline date of all topics within a budget component. There might be several deadlines within one budget component.

level2

String

Level 2 of the programme tree. [1]

level3

String

Level 3 of the programme tree. [1]

level4

String

Level 4 of the programme tree. [1]

level5

String

Level 5 of the programme tree. [1]

level6

String

Level 6 of the programme tree. [1]

level7

String

Level 7 of the programme tree. [1]

level8

String

Level 8 of the programme tree. [1]

level9

String

Level 9 of the programme tree. [1]

CapFpDivisionsNames

String

Technical field used for internal purposes.

MainSpecificProgrammeLevel1Name

String

Name of the programme pillar to which the call belongs to.

MainSpecificProgrammeLevel1Description

String

Description of the programme pillar to which the call belongs. Usually the same as the name.

SP_color

String

Colour of the pillar to which the call belongs. Possible options: PURPLE, BLUE, YELLOW, RED, MAGENTA, ORANGE, PINK, GREEN, BLACK. Used as visual element of display of Funding Opportunities.

PublicationDate

String

Publication date of the call.

PublicationDateLong

Long

Publication date of the call in long format – milliseconds since 1st January 1970 01:00:00 CET (Unix Epoch).


[1] EC programmes are organised into tree-like structure. The top level is typically at the level of the Funding programme, level 2 is typically the first level down (in H2020 referred to as 'pillars', in COSME referred to as 'objectives'), level 3 is typically 2nd level down, all the subsequent levels are representing further divisions of programme or calls or topics within calls.

5.4. Response sample

Fragment of Calls service response for random call:

6. Topics service [Back To Top]

The Topics service provides the list of all topics per programme with related metadata.

6.1. Uniform Resource Locator (URL)

Topic service with all topics published in the Participant Portal:

URL: http://ec.europa.eu/research/participants/portal/data/call/h2020/topics.json

Topics service is also available per programme under the following locations:

6.2. Structure

The Topics service has the following structure:

{
"topicData": {
                       "Topics": [ { topic1 }, { topic2 }, { topic3 }, { ... } ]
                   }
}

6.3. Description


Object {} /List [] /Attribute

Type

Description

topicData {}

Topics []

List of all topics for a given programme.

topicId

Long

Numeric value assigned to the topic.

topicFileName

String

Name of the topic page (html file) in the Participant Portal.

callProgramme

String

Abbreviation of the programme to which the topic belongs to.

callFileName

String

The name of the call page (html file) to which the topic belongs.

callStatus

String

Status of the topic. Possible values: Forthcoming, Open, Closed.

plannedOpeningDate

String

Planned opening date of the topic.

plannedOpeningDateLong

Long

Planned opening date of the topic in long format - milliseconds since 1st January 1970 01:00:00 CET (Unix Epoch).

publicationDate

String

Publication date of the call to which the topic belongs.

deadlineDates []

Array of String

List of topic deadlines.

deadlineDatesLong []

Array of Long

Topic Deadlines in long format - milliseconds since 1st January 1970 01:00:00 CET (Unix Epoch).

identifier

String

Topic identifier.

title

String

Topic title.

tags []

Array of String

List of tags associated with the topic.

flags []

Array of String

List of flags (e.g. h2020 cross-cutting priorities) associated with the topic. This field is optional. [2]

actions []

List of subsequent information on types of actions associated with the topic.

topicId

Long

Numeric value assigned to the topic.

types

Array of String

List of Types of Actions associated with the topic.

callType

Integer

Numeric value used internally.

plannedOpeningDate

String

Planned opening date of the action.

deadlineModel

String

Deadline model of the action. Possible values: single-stage, two-stage or multiple cut-off.

deadlineDates []

Array of String

List of all deadlines of the action.

callIdentifier

String

Unique identifier of the call to which the topic belongs.

callTitle

String

Title of the call to which the topic belongs.


[2] For reference data see paragraph 9.1 Flags.

6.4. Response sample

Fragment of Topics service response for random topic:

7. Topic Description service [Back To Top]

The Topic Description service provides a description of the individual topic.

7.1. Uniform Resource Locator (URL)

Topic Description service can be reached using the following URL template:

http://ec.europa.eu/research/participants/portal/data/call/topics/<identifier>.json

Value of <identifier> parameter can be retrieved from the Topics service. It should be made lowercase and placed in the above URL template with '.json' extension.

e.g. http://ec.europa.eu/research/participants/portal/data/call/topics/art-01-2017.json

7.2. Structure

The Topic Description service has the following structure:

{
         "identifier": ""
         "description": ""
}

7.3. Description


Object {} /List [] /Attribute

Type

Description

identifier

String

Unique identifier for a given topic.

description

String

Description of the topic.

7.4. Response sample

Fragment of Topic Description service response for random topic:

8. Call & Topic Updates service [Back To Top]

The Call & Topic Updates service provides a list of call and topic updates for all programmes available in the Participant Portal.

8.1. Uniform Resource Locator (URL)

The Call & Topic Updates service is available at the following location:
http://ec.europa.eu/research/participants/portal/data/call/h2020/latestinfos.json

8.2. Structure

The Call & topic updates service has the following structure:

{
      "aaData": [
                     [ callupdate1 ], [callupdate2 ],[ callupdate3 ],[ ... ]
                     ]
}

8.3. Description


Object {} /List [] /Attribute

Type

Description

Framework Program

String

Programme to which the update refers.

Related Call

String

Call to which the update refers.

Related Topic

String

Topic to which the update refers.

Update text

String

Text providing call or topic news.

Date

Timestamp

Time of the update.

8.4. Response sample

The Call & Topic Updates service response for random update:

9. FAQ index service [Back To Top]

The FAQ index service provides the list of all FAQs (active and archived) which are available in the Participant Portal. This service does not provide complete answers in FAQs, for that use FAQ details service.

9.1. Uniform Resource Locator (URL)

The FAQ index service is available under the following location:
http://ec.europa.eu/research/participants/portal/data/faq/all/faqs.json

9.2. Structure

The FAQ index service has the following structure:
{
"qas":[
                       { faq1 }, { faq2 }, { faq3 }, { ... }
                   ]
}

9.3. Description

Object {} /List [] /Attribute

Type

Description

nid

Integer

Node ID, unique ID of a FAQ item, used as a key in FAQ details service.

programmeList[]

Array of String

List of programmes to which this FAQ applies.

category

String

Category to which this FAQ applies.

categoryMachineName

String

Category machine name to which this FAQ applies.

question

String

Question text.

answer

String

Truncated 185 characters of the answer.

tagList[]

Array of String

List of tags associated with this FAQ.

publicationDate

Timestamp

Publication date.

top10

Boolean

It this FAQ in top 10 list?

archived

Boolean

Is this FAQ archived?


9.4. Response sample


10. FAQ details service [Back To Top]

The FAQ details service provides all data on FAQ items (active and archived) which are available in the Participant Portal.

10.1. Uniform Resource Locator (URL)

The FAQ index service is available under the following location:
http://ec.europa.eu/research/participants/portal/data/faq/nodes/faq-<nid>.json
where <nid> can be retrieved from FAQ index service
e.g. http://ec.europa.eu/research/participants/portal/data/faq/nodes/faq-750.json

10.2. Structure:

{
           { faq <nid> }
}

10.3. Description

Object {} /List [] /Attribute

Type

Description

nid

Integer

Node ID, unique ID of a FAQ item, used as a key in FAQ details service.

programmeList[]

Array of String

List of programmes to which this FAQ applies.

category

String

Category to which this FAQ applies.

categoryMachineName

String

Category machine name to which this FAQ applies.

question

String

Question text.

answer

String

Answer text

tagList[]

Array of String

List of tags associated with this FAQ.

publicationDate

Timestamp

Publication date.

top10

Boolean

It this FAQ in top 10 list?

archived

Boolean

Is this FAQ archived?


10.4. Response sample


11. Partner Search – Organisation Profile service [Back To Top]

The Partner Search – Organisation Profile service provides the list of projects of individual organisation.

11.1. Uniform Resource Locator (URL)

The Partner Search – Organisation Profile service is available under the following location:
https://ec.europa.eu/research/participants/api/orgProfile/data.json?pic=<PIC>
where <PIC> should be replaced with 9-digit PIC number of the organisation.
e.g. https://ec.europa.eu/research/participants/api/orgProfile/data.json?pic=123456789

11.2. Structure:

The Partner Search – Organisation Profile service has the following structure:
{
          "organizationProfile": {
                    "publicOrganizationData": {
                              "pic": "",
                              "legalName": "",
                              "businessName": "",
                              "address": {
                                        "country": "",
                                        "city": "",
                                        "phone": [],
                                        "fax": [],
                                        "email": []
                              },
                              "dataStatus": "",
                              "classificationType": "",
                              "resourceType": "",
                              "utropic":
                    },
                    "collaborations": [
                              {
                                        "pic": "",
                                        "legalName": "",
                                        "businessName": "",
                                        "numberOfProjects":
                              },
                    ],
                    "workProgrammes": {},
                    "consorsiumRoles": {},
                    "tagsAndKeywords": [],
                    "writePermissions":
          }
}

11.3. Description

Object {} /List [] /Attribute

Type

Description

organizationProfile {}

publicOrganizationData {}

pic

String

Organisation PIC number.

legalName

String

Organisation legal name.

businessName

String

Organisation business name.

Address {}

Organisation address.

country

String

Organisation country.

city

String

Organisation city.

phone

String

This field is not used.

fax

String

This field is not used.

email

String

This field is not used.

dataStatus

String

Oragnisation validation status (SELF-REGISTERED or VALIDATED)

classificationType

String

Organisation type.
See Organisation types in reference data.

resourceType

String

Internal field, always has the following value: "ORGANISATION"

utropic

Boolean

Internal field.

Collaborations []

List of collaborating organisations.

Pic

String

PIC number of collaborating organisation.

legalName

String

Legal name of collaborating organisation.

businessName

String

Business name of collaborating organisation.

numberOfProjects

Integer

Number of common projects.

workProgrammes {}

Array of String

List of programmes organisation is participating in.

consorsiumRoles {}

Array of String

List of organisation roles.

tagsAndKeywords []

Array of String

Organisation keywords.

writePermissions

Boolean

Internal field.


12. Partner Search – Organisation Projects service [Back To Top]

The Partner Search – Organisation Projects service provides the list of projects of individual organisation.

12.1. Uniform Resource Locator (URL)

The Partner Search – Organisation Projects service is available under the following location:
https://ec.europa.eu/research/participants/api/orgProfile/publicProjects.json?pic=<PIC>
where <PIC> should be replaced with 9-digit PIC number of the organisation.
e.g. https://ec.europa.eu/research/participants/api/orgProfile/publicProjects.json?pic=123456789

12.2. Structure:

The Partner Search – Organisation Projects service has the following structure:
{
          "publicProjects": [
                    {
                              "acronym": "",
                              "id": "",
                              "program": "",
                              "programId": "",
                              "title": "",
                              "phase": "",
                              "status": "",
                              "activityCodes": [],
                              "tobeLinked": "",
                              "minidashboardCountShown": "",
                              "resourceType": ""
                    }
          ]
}

12.3. Description

Object {} /List [] /Attribute

Type

Description

publicProjects []

List of organisation projects.

Acronym

String

Project acronym.

Id

Integer

Project identifier.

Program

String

Programme abbreviation.

programId

Integer

Programme identifier.

Title

String

Project title.

Phase

String

Phase of the project.

Status

String

Project status.

activityCodes []

Array of String

Internal field not used in the context of partner search.

tobeLinked

Boolean

Internal field not used in the context of partner search.

minidashboardCountShown

Boolean

Internal field not used in the context of partner search.

resourceType

String

Internal field not used in the context of partner search.


12.4. Response sample


13. Portal keyword tree service [Back To Top]

The portal keyword tree service provides the tree of all official keywords which are used in the proposals, projects and expert profiles in the context of EU grants.

13.1. Uniform Resource Locator (URL)

The portal keyword tree service is available under the following location:
http://ec.europa.eu/research/participants/portal/data/call/trees/portal_keyword_tree.json

13.2. Structure:

The portal keyword tree service has the following structure:
[
{
          "ccm2_Id": "",
          "description": "",
          "children": [
                    {
                              "ccm2_Id": "",
                              "description": "",
                              "name": "",
                              "parent": "",
                              "children": []
                    },
                    {child 2},
                    {child 3}
}

13.3. Description

Object {} /List [] /Attribute

Type

Description

ccm2_Id

Integer

Unique ID of a keyword.

description

String

Complete description of the keyword.

name

String

Short description of the keyword.

parent

Integer

Ccm2_Id of a parent node.

children[]

Array of keywords

List of children nodes of a keyword.


14. H2020 programme division tree service [Back To Top]

The H2020 programme division tree service provides a tree structure of the H2020 programme.

14.1. Uniform Resource Locator (URL)

The H2020 programme division tree service is available under the following location:
http://ec.europa.eu/research/participants/portal/data/call/trees/fp_division_tree.json

14.2. Structure:

The H2020 programme division tree service has the following structure:
"fpDivisions": [
          {
                    "id": "",
                    "ccm2Level": "",
                    "code": "",
                    "description": "",
                    "children": [
                              {
                                        "id": "",
                                        "ccm2Level": "",
                                        "code": "",
                                        "description": "",
                                        "parent": "",
                                        "children": []
                              },
                              {child 2},
                              {child 3}
                    ]
          }
]

14.3. Description

Object {} /List [] /Attribute

Type

Description

fpDivisions[]

Root element of the tree.

id

Integer

Unique ID of a keyword.

ccm2Level

String

Level of an item in the tree.

code

String

Code of an item.

description

String

Decription of item.

parent

String

Id of a parent node.

children

Array of child elements

Array of child elements of an item.


15. Reference Data [Back To Top]

15.1. Flags

The following table contains all possible flags which can be retrieved in Topics service response.

Flag

Description

X-KET

Cross-cutting Key-Enabling Technologies (KETs)

Gender

Gender

IntlCoop

International cooperation

SSH

Socio-economic science and humanities

InnovationProcurement

Innovation Procurement

cPPP

Contractual public-private partnership

cPPPsubDivision EeB

Energy-efficient Buildings

cPPPsubDivision FoF

Factories of the Future

cPPPsubDivision HPC

High Performance Computing

cPPPsubDivision 5G

Advanced 5G Network Infrastructure for Future Internet

cPPPsubDivision BigData

Big Data

cPPPsubDivision Robotics

Robotics

cPPPsubDivision Photonics

Photonics

cPPPsubDivision SPIRE

Sustainable Process Industries and Resource Efficiency

cPPPsubDivision EGVI

Green vehicles

cPPPsubDivision Y

Contractual public-private partnership in WP 2014-2015

ERANET

ERA-NET

SME

SME instrument

OpenInnovation

Open Innovation

OpenScience

Open Science

OpenToTheWorld

Open to the World


15.2. Organisation types

The following table contains all possible organisation types which can be retrieved in Partner Search – Organisation Profile service response.

Organisation type

Description

SME

Small and medium-sized enterprise

International organisation

International organisation

Higher or secondary education

Higher or secondary education

Research organisation

Research organisation

Private for profit organisation

Private for profit organisation. It is not SME not Higher or secondary education.

Public organisation

Public organisation. It is not an International Organisation, nor Higher or secondary education nor Research organisation.

Other

Organisation type which does not fit into any of above types.