Met de generieke koppeling kun je automatisch deelnemers in en uitschrijven voor e-learnings. Dit kun je inrichten met de onderstaande instructies.


Autorisatie via OAuth 2.0

Er wordt gebruik gemaakt van OAuth 2.0 met ‘Authorization code grant’ voor de autorisatie.

Er wordt door het e-learning pakket een access-token (bearer token) in combinatie met een refresh token aangeboden aan Coachview. Hiermee kan Coachview zich autoriseren bij het e-learningpakket en het inschrijven en uitschrijven van een deelnemer aansturen. Het token wordt in de header meegestuurd.

Documentatie: https://oauth.net/2/


Werkwijze

Er wordt uitgegaan van één endpoint waarmee zowel het inschrijven als het uitschrijven mogelijk is. Inschrijven verloopt via POST en uitschrijven verloopt via DELETE.


Inschrijven (HTTP Method: POST)

De benodigde gegevens voor het inschrijven van een deelnemer worden in JSON formaat verstuurd.

Voorbeeld:

[ {

  "PersoonExterneId": "p12345",

  "PersoonVoornaam": "Jan",

  "PersoonTussenvoegsels": "",

  "PersoonAchternaam": "Jansen",

  "PersoonEmailadres": "jan@jansen.nl",

  "Elearningcode": "e12345"

  }

]


N.B.: Het e-learningpakket zorgt ervoor dat gecontroleerd wordt of de gebruiker bestaat en of de gebruiker aangemaakt en/of gewijzigd moet worden.


Uitschrijven (HTTP Method: DELETE)

De benodigde gegevens voor het uitschrijven van een deelnemer worden als parameters meegestuurd.

Voorbeeld:

?PersoonExterneId=p12345&Elearningcode=e12345



HTTP Status codes

Er wordt uitgegaan van de standard HTTP status codes, waarbij geldt dat status 200 betekent dat het bericht succesvol is verwerkt.

Overige status status codes dienen van een duidelijke melding voorzien te zijn die beschrijven wat er fout gaat.

Documentatie: https://developer.mozilla.org/nl/docs/Web/HTTP/Status