Documents and specifications

Summary:

This document explains how the technical part of EWP documentation is divided, where it is stored, how it should be designed, read and approved.

"Technical part" refers to the part designed for software developers (the one you are reading just now). There are lots of other types of documentation related to the EWP project, but we are not discussing them here.

The content of this chapter in included in the following sub-chapters, with documents and specifications related to network architecture, authentication and security.

Summary:

This document describes EWP vocabulary, network components, common features and data types, and explains basic rules about how partners communicate with each other and handle errors.

Summary:

This document describes how EWP deals with integrity and confidentiality of the messages exchanged.

Chapter 2.3.1. Handling Anonymous Clients (version 1.1.0 - LATEST RELEASE)

Summary:

This document describes how EWP servers should declare that some of their endpoints can handle anonymous clients.

Chapter 2.3.2. Authenticating Clients with TLS Certificate (version 1.1.2 - DISCONTINUED)

Summary:

This document describes how to accomplish EWP client authentication with the use of TLS Client Certificates.

Chapter 2.3.3. Authenticating Clients with HTTP Signature (version 1.0.1 - LATEST RELEASE)

Summary:

This document describes how to accomplish EWP client authentication with the use of HTTP Signatures.

Chapter 2.4.1. Authenticating Servers with TLS Certificate (version 1.1.0 - LATEST RELEASE)

Summary:

This document describes how EWP server authentication can be accomplished with the use of TLS Server Certificates, CAs, and the Registry.

Chapter 2.4.2. Authenticating Servers with HTTP Signature (version 1.0.2 - LATEST RELEASE)

Summary:

This document describes how EWP server authentication can be accomplished with signatures included in HTTP responses.

Chapter 2.5.1. TLS and Request Confidentiality (version 1.1.0 - LATEST RELEASE)

Summary:

This document describes how to accomplish confidentiality of EWP HTTP requests with the use of TLS transport.

Chapter 2.5.2. .ewp-rsa-aes128gcm Request Encryption (version 0.4.0 - REVIEW RECOMMENDED)

Summary:

This document describes how to accomplish confidentiality of EWP HTTP requests with the use of ewp-rsa-aes128gcm encryption.

Chapter 2.6.1. TLS and Response Confidentiality (version 1.1.0 - LATEST RELEASE)

Summary:

This document describes how to accomplish confidentiality of EWP HTTP responses with the use of TLS transport.

Chapter 2.6.2. .ewp-rsa-aes128gcm ResponseEncryption (version 0.3.0 - REVIEW RECOMMENDED)

Summary:

This document describes how to accomplish confidentiality of EWP HTTP responses with the use of ewp-rsa-aes128gcm encryption.

The content of this chapter in included in the following sub-chapters, with documents and specifications related to primary network APIs.

Summary:

Discovery API is the first API that the partner developer needs to implement in order to become a basic member of the *Erasmus Without Paper* Network.

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.

Summary:

This API allows beginner EWP developers to test the security of their EWP Network connections. It doesn't "do" anything, but it requires the developer to implement the core security framework (which will be needed by all the other APIs later on).

Summary:

This document describes the API implemented by the Registry Service. It is placed in the "APIs" section of the documentation, but this does not imply that we want you to implement it. You will be only using it (as a client).

See section Mobility Process.

The content of this chapter in included in the following sub-chapters, with documents and specifications related to general purpose APIs.

Chapter 5.1.1. Institutions API (version 2.2.0 - LATEST RELEASE)

Summary:

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

Chapter 5.1.2. Organizational Units API (version 2.1.1 - LATEST RELEASE)

Summary:

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

Chapter 5.2.1. Courses API (version 0.7.1 - REVIEW RECOMMENDED)

Summary:

This document describes the Courses API. This API is not directly related to EWP mobility APIs, but it might help with building user-friendly mobility client software. It allows other HEIs to access information on courses and other learning opportunities conducted in this institution.

Chapter 5.2.2. Simple Course Replication API (version 1.0.0-RC9 - REVIEW RECOMMENDED)

Summary:

This document describes the Simple Course Replication API. This API can be implemented by any HEI, even it is does not take part in EWP mobility process. Once implemented, it 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.

Summary:

This document describes the File API. This API allows partners to share files securely.

Summary:

This document describes the Monitoring API implemented by the EWP Stats Portal, which is hosted by EWP administrators. This API allows clients in the EWP network to inform the network's administrators about any issues encountered when making requests. It SHOULD NOT be implemented by anyone other than the EWP Stats Portal. You will be only using it as a client.

See section Mobility Process.

Summary:

This document describes the Beneficiary Module Mobilities API. It is assumed that this API is implemented by only one host managed by the Directorate-General Education and Culture Unit (DG EAC) of the European Commission.

Once implemented by the host, it allows external clients to automatise reporting of individual mobilities of students to the Beneficiary Module.

Summary:

This document describes the Student Service Providers API. This API provides a structured overview about the available student services at the receiving institution.

The content of this chapter in included in the following sub-chapters, with documents and specifications related to supplementary data formats.

Summary:

This document describes the .ewpmobility file format. This specialized file format is intended for exchanging student mobility data, in a form strictly compatible with EWP. .ewpmobility files might prove useful when moving mobility data from one institution to another, i.e. when migrating to EWP workflow.

Summary:

This repository contains XML Schemas used in EWP APIs for street and postal addressing. It follows the same versioning rules as all EWP APIs do. Other projects are welcome to reuse this schema, along with its namespace. We are also open to suggestions of extending it.

Summary:

This repository contains XML Schemas used in EWP APIs for encoding phone and fax numbers. It follows the same versioning rules as all EWP APIs do. Other projects are welcome to reuse this schema, along with its namespace. We are also open to suggestions of extending it.

Summary:

This repository contains XML Schemas used in EWP APIs for addressing academic years and academic terms. It follows the same versioning rules as all EWP APIs do. Other projects are welcome to reuse this schema, along with its namespace. We are also open to suggestions of extending it.

Summary:

This repository contains XML Schema used in some EWP APIs in contexts when multiple, non-identifiable, abstract contact entities need to be attached to a business entity. It follows the same versioning rules as all EWP APIs do.

Summary:

This repository describes the identifier type we plan to use in EWP APIs to uniquely identify people. It follows the same versioning rules as all EWP APIs do. Other projects are welcome to reuse this data type, along with its XML namespace. We are also open to suggestions of extending this document.

Summary:

This document describes a format which can be used to transfer encrypted binary payload to a single recipient, with help of symmetric AES-128 GCM encryption and the recipient's public RSA key.