mdemare / specification

OpenAPI (fka Swagger) specification for the Open Education API.

Open Education API Specification

This repository contains the OpenAPI (fka Swagger) specification for the Open Education API.

• Versions
• Operating area and Application
• Contributing
• Mailinglist
• Community
• Roadmap

If you have a question, a Slack channel is available at: openonderwijsapi.slack.com.

Versions

This is the current version:

• v4 (Current version - v4)

The future v5 versions is available as a Release Candidate. This version is still under active development and will change. It is not yet suitable for implementation.

• v5 (Next version - v5) easy dev access

These are the previous versions:

• v3 (Previous version - v3)
• v2 (Previous version - v2)
• v1 (Previous version - v1)

Operating area and Application

The Open Education API is typically used to make educational data available. With educational data we mean the data that is typically stored in the educational systems like the Student Information System (SIS), the Learning Management System (LMS) etc. Think of marks and study credits, course information, schedules and timetables. Organizations can now publish this educational data in a standardised way by implementing their own Open Education API, following the the Open Education API specification. By doing so, application developers can then integrate education data that has been made available by the Open Education API implementations of the different educational organizations in an uniform way, into new exiting applications. See for more information about this project: https://openonderwijsapi.nl/en/

Contributing

The Open Education API is an open source, community-driven project. If you'd like to contribute, please follow the Contributing Guidelines.

Mailinglist

A public mailinglist is available. Users can subscribe at: https://list.surfnet.nl/mailman/listinfo/openonderwijsapi

Community

The Open Education API is driven by the Open Education API Working Group. The working group includes representatives of higher educational organizations and suppliers.