APIs

Operation of the EWP network is based on the set of APIs. These APIs come in groups related to specific business processes, like handling inter-institutional agreements, learning agreements, nominations, etc. This grouping is described, and the description is supported by scenarios showing business and technical perspectives and sharing hints on implementation and good practices.

API Versioning

The following status labels are used for released APIs:

• LATEST RELEASE – the latest accepted version of the API;

• OBSOLETE – might still be in use, but a newer version exists;

• DEPRECATED – might still be in use, but SHOULD be upgraded;

• DISCONTINUED – might have been used in the past, but is no longer used; do not use it.

Primary network APIs

Discovery manifest API

Discovery manifest files serve to announce which HEIs your system covers, which features (APIs) you have implemented, and which credentials your clients are going to use when fetching the data from the EWP network.

Echo API

Echo API is used to design and test the authentication and security framework of the network.

Registry API

This API is implemented by the EWP Registry Service and it returns the catalogue file with information gathered from the manifest files.

EWP mobility process explained

With help of some flowcharts, this document describes how the Student Mobility Business Process is modelled within the EWP network.

General purpose APIs

Institutions and faculties

Institutions API allows external clients to retrieve general information on institutions either covered, or otherwise known, by the host. This information includes things like address, logo image and key contact persons.

Organizational Units API allows external clients to retrieve general information on selected organizational units (faculties, departments, divisions, etc.) either covered, or otherwise known by the host. It responds with a similar type of information as Institutions API does, but on a lower level.

Courses

Courses API allows other HEIs to access information on courses and other learning opportunities conducted in a given HEI.

Simple Course Replication API allows the clients to replicate the catalogue of courses conducted on this HEI. This in turn allows the clients to design rich course searching user experience.

File API

This API allows partners to share files securely.

Monitoring API

This API allows clients in the EWP network to inform the network's administrators about any issues encountered when making requests.

Erasmus mobility APIs - Inter-institutional agreements API

Inter-institutional agreements API

This API allows partners to compare their copies of inter-institutional Erasmus+ mobility agreements with each other, which makes it easier to spot errors. This API is complementary with the Inter-institutional agreements approval API where HEIs can approve agreements they exchange via the IIAs API.

Inter-institutional agreements CNR API

This API allows the partners to listen for changes in other copies of their IIAs kept in the EWP network.

Inter-institutional agreements Approval API

This API allows HEIs to approve agreements sent by their partners in the Inter-institutional agreements API.

Inter-institutional agreements Approval CNR API

This API allows the partners to listen for approvals of their copies of the IIAs.

Mobility Factsheet API

This API allows partners to share all the information useful for incoming students in the mobility process.

Erasmus mobility APIs - Outgoing Mobilities (Nominations and LAs)

Outgoing Mobilities API

This API is implemented by the sending institution. It allows the receiving HEI to read, write and enumerate mobilities stored on the sending HEI's servers.

Outgoing Mobility Learning Agreements API

This API is implemented by the sending institution. It allows the receiving HEI to read and accept learning agreements stored on the sending HEI's servers and propose changes to them. This API is based on the official LA template.

Outgoing Mobility CNR API

This API is implemented by the receiving institution if it wants to be notified whenever mobilities kept on their partner institutions' servers are changed.

Outgoing Mobility Learning Agreements CNR API

This API is implemented by the receiving institution if it wants to be notified whenever learning agreements kept on their partner institutions' servers are changed.

Erasmus mobility APIs - Incoming Mobilities (Nominations and ToRs)

Incoming Mobilities API

This API is implemented by the receiving institution. It allows the sending HEI to read the receiving HEI's part of the information related to the sending HEIs outgoing mobilities.

Incoming Mobility CNR API

This API is implemented by the sending institution if it wants to be notified whenever incoming mobilities kept on their partner institutions' servers are changed.

Incoming Mobility ToR API

This API is implemented by the receiving institution. It allows the sending institution to retrieve Transcripts of Records issued by the receiving institution for a given set of mobility IDs.

Incoming Mobility ToR CNR API

This API is implemented by the sending institution if it wants to be notified whenever Transcript of Records served by the receiving institution (via the Incoming Mobility ToRs API) are changed.

Beneficiary Module Mobilities API

This API is implemented by only one host managed by the Directorate-General Education and Culture Unit (DG EAC) of the European Commission. It allows external clients to automatise reporting of individual mobilities of students to the Beneficiary Module.

EWP Student Service Providers API

This API provides a structured overview about the available student services at the receiving institution.