The NED implementation is based on these technical principles.
- Based on OOAPI
- direct communication between all parties, no central hub
- minimal data exposure of student information
- no vendor lock-in
- use proven standards for authorization and authentication (OAUTH2)
A simple overview of the exchanges between the three functionalities is as follows, where data objects are depicted in the flows:
Each functionality is related to one of more MORA reference components:
Each Party in the NED Ecosystem provides and consumes APIs according to their roles. The table outlines these APIs.
| API Definition | Service Provider | Services Consuming | Remarks |
|---|---|---|---|
| flow 0 : Test catalogue | Toetsafname | SIS & Toetsplanning | |
| flow 1 : Test participants | SIS | Toetsplanning | |
| flow 2 : Test offerings and enrollments | Toetsplanning | Toetsafname | |
| flow 3 : Test results | Toetsafname | Toetsplanning | |
| flow 4 : Test offering report | Toetsafname | Toetsplanning | |
| flow 5 : Student results to SIS | Toetsplanning | SIS | |
| flow 6 : Analysis | SIS | Toetsafname |
TODO: Describe all relevant standards for parties that want to join the ecosystem.
- OOAPI v5
- OAUTH2
- We are currently investigating the use of edukoppeling a question here is do we HAVE to useedu_org_id? Do we really want to alllow for all 4 levels of Data Classification or are we only using 2?
- the connection to MORA has also been made in this project.
The information model used within the OKE ecosystem and the translation to OOAPI, with focus on component, offering, association and person.
In the definitiob of the data objects are all data within the object at the delivery (POST and PUT) of the distribution (GET) mandatory or recommended/optional as denoted in the specification document. Other data that could be used will be ignored at reception.
At the delivery of a change (PATCH) all unchanged data may be missing. The deletion of a singular data field (must be optional) can be done by delivering the value null (this value null is allowed for PATCH), also when the element is not nullable (nullable=false). The deletion of a plural data element (must be optional) in an array, can be done by delivery of an empty array; an empty array is allowed even when the element is defined as non-empty (minItems=1).