This document describes the Mobility Tool+ Projects API. It is assumed that this API is implemented by only one host managed by the Directoriate-General Education and Culture Unit (DG EAC) of the European Commission. However, the specification itself does not limit the number of hosts.
Once implemented by the host, it allows external clients to retrieve list of projects for a particular institution and call year.
- Requests MUST be made with either HTTP GET or HTTP POST method. Servers MUST support both these methods. Servers SHOULD reject all other request methods.
Parameters MUST be provided in the regular application/x-www-form-urlencoded
format.
A PIC of institution the client wants to retrieve information on.
Clients may retrieve proper PIC from other EWP APIs (most often, the Registry Service).
A call year (integer) of projects being returned.
This version of this API uses standard EWP Authentication and Security, Version 2. Server implementers choose which security methods they support by declaring them in their Manifest API entry.
This API provides data which is also usually accessible to the anonymous public by other channels. It is RECOMMENDED for server implementers to not be overly strict on security methods they require (i.e. it is RECOMMENDED to not require extra layers of encryption in requests and responses - TLS seems more than enough). Server implementers MAY also consider allowing this API to be accessed by anonymous clients.
-
General error handling rules apply.
-
Invalid (unknown)
pic
MUST result in a HTTP 400 error. -
We assume every positive integer being a valid
call_year
. If the providedpic
is valid and there are no projects for the providedcall_year
, server MUST return a valid (HTTP 200) XML response with noproject
elements.
Servers MUST respond with a valid XML document described by the response.xsd schema. See the schema annotations for further information.