Skip to content

Commit

Permalink
Add ooapi to index
Browse files Browse the repository at this point in the history
  • Loading branch information
phavekes committed Sep 17, 2024
1 parent cf7dcd6 commit aea85a9
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 10 deletions.
17 changes: 8 additions & 9 deletions connecting-ooapi.endpoints.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# [Step 1. Implementing an OOAPI endpoint](https://wiki.surfnet.nl/display/EDX/Step+1.+Implementing+an+OOAPI+endpoint)


Eduxchange relies on the [Open Onderwijs API (OOAPI)](https://openonderwijsapi.nl/#/) standard to function. To enable Eduxchange to operate correctly, your educational institution must have an OOAPI endpoint that adheres to this standard.

![conceptual-model](images/conceptual-model.png)
Expand All @@ -9,9 +8,9 @@ Your institution's OOAPI endpoint will function as a standardized interface that

Eduxchange utilizes OOAPI for the following processes:

1. **Retrieving information about educational offerings** to display on [eduxchange.nl](http://eduxchange.nl/) or eduxchange.eu.
2. **Enrolling students** in educational offerings.
3. **Transmitting students' grades** from the guest institution back to the home institution.
1. **Retrieving information about educational offerings** to display on [eduxchange.nl](http://eduxchange.nl/) or eduxchange.eu.
2. **Enrolling students** in educational offerings.
3. **Transmitting students' grades** from the guest institution back to the home institution.

## Implementation Guidelines

Expand All @@ -25,19 +24,19 @@ Eduxchange utilizes a subset of the OOAPI specification. The specific parts that

- Some institutions may already have an OOAPI endpoint for other use cases. If so, a significant portion of the work might already be completed.

- For example, most Dutch institutions already have an OOAPI endpoint that is used to provide data to RIO (DUO).
- For example, most Dutch institutions already have an OOAPI endpoint that is used to provide data to RIO (DUO).
- Identify the systems where Eduxchange data is stored.

- Sometimes those systems already have API's or interfaces that can be used to build you endpoint upon.
- Sometimes those systems already have API's or interfaces that can be used to build you endpoint upon.

- In other cases such interfaces might not be available, which makes implementing your OOAPI endpoint more challenging.
- In other cases such interfaces might not be available, which makes implementing your OOAPI endpoint more challenging.

- In all cases it is useful to identify the persons who manage your educational systems and contact them.

- Map your data to the OOAPI data model.

- This step requires that you study the OOAPI standard and Eduxchange profile and compare them to the datamodels of your institutions' systems.
- This step requires that you study the OOAPI standard and Eduxchange profile and compare them to the datamodels of your institutions' systems.
- Create a REST API that adheres to the [OOAPI standard](https://openonderwijsapi.nl/specification/v5/docs.html) and the Eduxchange profile \[LINK\] on your system(s).

- This step will usually involve development work requiring some time of a programmer.
- This step will usually involve development work requiring some time of a programmer.
- You can [validate your endpoint using our validator](https://wiki.surfnet.nl/display/EDX/Step+4.+Validating+your+OOAPI+endpoint).
8 changes: 7 additions & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,17 @@

Eduxchange.eu technical documentation lives here

## openonderwijsapi

- [How to connect OOAPI endpoints](./connecting-ooapi.endpoints.md)

## About Enrolment
- How does the enrolment work in general?

- How does the enrolment work in general?
- [Sequence diagram for EuroTeQ enrolment](./sequence-diagram.md)

## About the enrolment receiver

- Can you tell me more about the communication between the generic part of the enrollment
receiver and the custom implementation at the host institution?
- [Communication dataformat](./dataformat.md)
Expand Down

0 comments on commit aea85a9

Please sign in to comment.