Skip to content

Commit

Permalink
Add intro
Browse files Browse the repository at this point in the history
  • Loading branch information
phavekes committed Nov 7, 2024
1 parent cc02f2b commit 4777a41
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 4 deletions.
4 changes: 2 additions & 2 deletions association-states.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ btw: states can change later.
## Explanation of rules governing the association state (Home Institution)

- pending (proces is waiting on the status of the students home institution)
- associated (the student is enrolled in the learning activity)
- associated (the student is approved for the learning activity)
- canceled (by student)
- denied (either learning activity is stopped or student is not allowed)
- queued (student is put on a waiting list)

## Explanation of rules governing the association remoteState (Host Institution)

- pending (proces is waiting on the status of the students home institution)
- associated (the student is enrolled in the learning activity)
- associated (the student is approved in the learning activity)
- canceled (by student)
- denied (student is not allowed)
- queued (student is put on a waiting list)
Expand Down
Binary file modified images/inschrijven-gastinstelling-EN.drawio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/overview.drawio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 14 additions & 2 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# This is a FAQ

## Overview

[![Overview](/images/overview.drawio.png)](/images/overview.drawio.png)

For enabeling automated enrolment in a aliance, each institutions will play the
role of the home institition (sending students out) en the host institution
(receiving students).
The home institution must have the required OOAPI endpoints available.
The host institution will run a component called enrollment receiver for
authentication and authorisation.
The host institution will always be in the lead for communication.

## About OOAPI

- [How to connect OOAPI endpoints?](./connecting-ooapi.endpoints.md)
Expand Down Expand Up @@ -52,13 +64,13 @@ Once the Host instutution has done the initial processing after the Enrollment R

## About the enrollment receiver

- How do I install or the enrollment receiver?
- It's advised to use the docker image [as described here](./running.md)
- 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)
- Do you have an example configuration of the enrollment receiver?
- [example application.yaml for enrollment receiver](./application.yaml)
- How do I run the enrollment receiver?
- It's advised to use the docker image [as described here](./running.md)
- What is the response from the SIS to the enrollment receiver?
- After processing the enrollment request in the host institution, and
informing the home institution a response is returned to the enrollment receiver. The HTTP status code should always be 200, and the response should look like this:
Expand Down

0 comments on commit 4777a41

Please sign in to comment.