You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 19 Next »

Översikt

Informationsmodell

Open Education API attributlistor

Interaktionsmodell och transport

Open Education API är definierat som ett rent HTTP/REST-API med väldefinierade resurser. Dokumentationen och swagger-definitionerna beskriver dock bara en implementation av GET-metoden, vilket i sammanhanget är begränsande. Dokumentationen beskriver inte en förväntad implementation för någon av de andra metoderna (POST/PUT/PATCH/DELETE) för att hantera övriga CRUD-operationer. Inte heller någon metod för att implementera händelsebaserad notifiering av nya/ändrade objekt, i form av webhooks eller motsvarande, beskrivs.


Interoperabilitet

Målgrupp


Standardens målgrupp är universitet och institutioner för högre utbildning. Även om det inte explicit uttrycks, så ges intrycket att det även främst inriktar sig mot aktörer i Nederländerna. Exempel på detta är formulär och best-practice som enbart ges på holländska.


Standarden är utvecklad och underhålls av SURFnet, ett samarbete mellan ICT organisationer i nederländerna för holländska utbildningsorganisationer.

Inriktning


Specifikationen har som inriktning att dela data öppet mellan aktörer inom utbildningssektorn, med stöd för data om personer, fakulteter, institutioner, kursplaner, grupper, kurser, resultat, byggnader, tillgängliga arbetsplatser, scheman, och nyheter. Specifikationen på så vis är ganska rätt inriktad mot de ändamål som vi undersöker.

Utbredning


Standarden används i nederländerna, men visar inget tecken på utbredning utanför landet. Alla organisationer listade på standardens hemsida är universitet eller institutioner för högre studier i nederländerna. Däribland verkar de stora spelarna vara University of Amsterdam samt Zuyd University of Applied Sciences.

Antalet systemleverantörer är okänt, men inga resultat har gått att hitta och inga listas under "Implementationer" på standardens hemsida.

Det saknas en öppen färdig implementation av standarden. Standarden publicerar en swagger-definition som går att konsumera för att generera klienter för att konsumera tjänster som implementerar standarden. Dock finns det ej någon systemnivås implementation av standarden att använda. Du kan generera stubs för server API-delen från swagger-definitionen

Livscykel

Standarden påbörjade 22 april 2016 som en del av nederländska EduChallenge, och första publiceringen gjordes i september/november 2016. För nuvarade är standarden på version V2.1, som släpptes i juli 2018. Att avgöra från de planerade kommande ändringar är det inte revolutionära ändringar som görs. T.ex. funderas det på hur man ska hantera flerspråkiga svar, och arbete på utökad dokumentation. Standarden kan anses till viss del stabil, men verkar lida lite av värkar av att vara så pass ny. Standarden kan ej anses stagnerad, utan är under aktiv utveckling. Standarden har en påbörjad draft på en version de kallar V3. Det en dock enbart en mindre justering, och kan inte kallas en "ny" standard.

Teknisk kvalitet

Standarden är primärt beskriven i form av en Open API (Swagger) definition i YAML format. Den huvudsakliga dokumentationen är genererad utifrån denna definition. För att uppnå enhetliga implementationer av en standard så krävs mer detaljerad dokumentation och mer utvecklade riktlinjer och guidelines än vad som i dagsläget tillhandahålls.

Utökningsbarhet

Inga möjligheter till egendefinierade utökningar finns definierade i standarden.

Täckningsgrad i jämförelse med Ladok 3:s informationsmodell

Documents and references

Document/referenceLink
UML Class diagram (Visio)OEAPI UML ClassDiagram.vsdx
InformationsmodellOOAPI_model.jpg
Dokumentationhttps://rawgit.com/open-education-api/specification/v2/docs.html#
Web sitehttps://openonderwijsapi.nl/en/
Ladok entity mappingLadokEntityMapping OEAPI.vsdx
Open API definitionspecification-3.zip
  • No labels