Skip to content

OOAPIv40_dataexchange

Jump to bottom
hamrt edited this page Apr 30, 2021 · 3 revisions

OOAPI data exchange and relations with other specifications

OOAPI is currently developed as part of a thee layer approach Data –> interface type –> API realisation. A realisation also has a Use case

OOAPI datamodel and interfacing

Currently there is one API realisation available: the REST interface. The current rest interface is a further detail of the overall OOAPI data model. In some cases the data model has been comprised to make end points easier to consume, for example the aggregated type of education is not available as an endpoint only the three specific forms, program, course and component. For offerings a different approach has been chosen mostly to make the relation with an association reusable. The REST interface has been creates based on the REST-API-Desgin-rules.

The OOAPI specification itself is NOT an API. It is a specification that is provided to the public for implementation by educational institutions. Currently SURF is performing tests and live implementations of the OOAPI specification in an API for the OOAPI-gateway and a course exchange.

In the development of the OOAPI data model and REST specification special attention was given to existing IMS and European standardisation activities, such as ECTS course catalogue, IMS OneRoster, IMS LIS and IMS edu API. There has also been information exchange with RIO and HOVI development. Because of different use cases, E.g. HOVI focusses more on marketing and communication data there is no complete match.

Where possible a match has been made.

These matches are:

  • Implementation of the ECTS guidelines and mapping of these elements can be found here
  • Comparisons between HOVI v2 and OOAPI v4 can be found here and here
  • A comparison between RIO HO (underdevelopment at dec 2020) and OOAPI v4 can be found here

Link with policies and other standards:

The development of the OOAPI has also been influenced by existing standards and regulations based on the Dutch comply or explain / pas toe of leg uit list. For the development the "digikoppeling" has been used as a guideline. For the development the following elements were taken into account:

Clone this wiki locally