Het OOAPI v4 datamodel is beschreven op https://open-education-api.github.io/specification/v4/docs.html. Op die pagina zijn het datamodel en de api endpoints te vinden.
Voor het ontsluiten van onderwijsaanbod data is het van belang de kern van het datamodel te implementeren. Deze kern bestaat uit de volgende objecten:

The OOAPI v4 data model is described at https://open-education-api.github.io/specification/v4/docs.html. The data model and the api endpoints can be found on that page.
To unlock educational data, it is important to implement the core of the data model. This core consists of the following objects:

  • service (het / endpoint)
  • academic-sessions
  • associations (role: lecturer & coordinator)
  • courses
  • offerings (type: programOfferings & courseOfferings)
  • organizations
  • persons (type: teacher & coordinator)
  • programs

Endpoints

Van deze objecten dienen de volgende endpoints te worden gemaakt:

The following endpoints are to be created from these objects:

  • GET /
  • GET /academic-sessions
  • GET /academic-sessions/{academicSessionId}
  • GET /academic-sessions/{academicSessionId}/offerings
  • GET /associations/{associationId}
  • GET /courses
  • GET /courses/{courseId}
  • GET /courses/{courseId}/offerings
  • GET /offerings/{offeringId}
  • GET /offerings/{offeringId}/associations
  • GET /organizations
  • GET /organizations/{organizationId}
  • GET /organizations/{organizationId}/programs
  • GET /organizations/{organizationId}/courses
  • GET /organizations/{organizationId}/offerings
  • GET /persons
  • GET /persons/{personId}
  • GET /persons/{personId}/associations
  • GET /programs
  • GET /programs/{programId}
  • GET /programs/{programId}/courses
  • GET /programs/{programId}/offerings


Visualisatie

In onderstaande plaat is de kern van het datamodel gevisualiseerd door deze objecten groen te arceren.

Merk op dat de objecten in het datamodel niet één-op-één matchen met de endpoints in de API. De gele objecten zijn afzonderlijke objecten in het datamodel, maar zijn in de API gespecificeerd als onderdeel van de groene objecten. De rood gearceerde objecten vallen buiten de kern die noodzakelijk is voor onderwijsaanbod data.

Visualisation

In the figure below, the core of the data model is visualised by the green objects.

Note that the objects in the data model do not match the endpoints in the API one-to-one. The yellow objects are separate objects in the data model, but are specified in the API as part of the green objects. The red objects fall outside the core which is necessary for educational supply data.




  • No labels