○ API calls - Bundels
Deze API calls maken het mogelijk om:
- informatie over bestaande bundles en bundeluitvoeringen op te halen
- informatie over inschrijvingen voor bundeluitvoeringen op te halen
- deelnemers in te schrijven voor een bundeluitvoering
- deelnemers uit te schrijven van een bundeluitvoering
- deelnemersgroepen in te schrijven voor een bundeluitvoering
Context
aNewSpring heeft bundels die bestaan uit meerdere templates. Een bundel kan meerdere bundeluitvoeringen hebben die uit meerdere uitvoeringen bestaan.
Je kunt deelnemers of deelnemersgroepen inschrijven voor een bundeluitvoering, ze kunnen dan meerdere uitvoeringen doen.
Supportartikelen:
Om historische redenen en om oude API-integraties te blijven ondersteunen, komt de terminologie van de API en de front-end voor beheerders niet altijd helemaal overeen. Daarnaast is de terminologie van de API gebaseerd op de Engelstalige versie van aNewSpring.
- Een inschrijving is een subscription.
- Een bundeluitvoering is een bundleCourse.
- Een deelnemer is een learner.
- Een deelnemersgroep is een learner group.
API calls
De Bundle API calls zijn alleen zichtbaar wanneer de Bundle functionaliteit ook is ingeschakeld door de Omgevingsbeheerder via de tab Instellingen.
Je kunt meer informatie vinden over elke API call in de API Documentation door op de titels hieronder te klikken. Alle links verwijzen echter naar de /apidocs pagina van een demo-omgeving die je niet kunt gebruiken om zelf te testen.
Om de API calls te testen, zul je het eerste deel van de URL moeten aanpassen naar de URL van je eigen leeromgeving.
GET requests
GET /getBundles
Hiermee kun je alle bundeltemplates ophalen die een externe ID hebben. Je kunt ook bundeltemplates zonder externe ID ophalen door de parameter includeWithoutId met waarde true mee te sturen.
GET /getBundleCourses/{bundleID}
of GET /getBundleCourses?bundleUID={bundleUID}
Hiermee kun je alle bundeluitvoeringen van een specifieke bundeltemplate ophalen. Je moet hiervoor de externe ID (bundleID) of UID (bundleUID) van de bundeltemplate gebruiken.
GET /getBundleCourseSubscription/{userID}/{bundleID}
of GET /getBundleCourseSubscription?userUID={userUID}&bundleUID={bundleUID}
Hiermee kun je details van een bundelinschrijving ophalen van een specifieke gebruiker en bundeluitvoering. Je moet hiervoor de externe ID's (userID/bundleID) of UID's (userUID/bundleUID) van de gebruiker (deelnemer) en de bundeluitvoering gebruiken.
GET /getBundleCourseSubscriptions/{userID}
of GET /getBundleCourseSubscriptions?userUID={userUID}
Hiermee kun je de details van alle bundelinschrijvingen van een specifieke gebruiker ophalen. Je moet hiervoor de externe ID (userID) of UID (userUID) van de gebruiker gebruiken.
POST requests
POST /subscribeBundle/{userID}/{bundleCourseID}
of POST /subscribeBundle?userUID={userUID}&bundleCourseUID={bundleCourseUID}
Hiermee kun je een deelnemer inschrijven voor een specifieke uitvoering. Je moet hiervoor de externe ID's (userID/bundleCourseID) of UID's (userUID/bundleCourseUID) van de gebruiker (deelnemer) en bundeluitvoering gebruiken.
POST /subscribeGroupBundleCourse/{bundleCourseID}/{learnerGroupID}
of POST /subscribeGroupBundleCourse?bundleCourseUID={bundleCourseUID}&learnerGroupID={learnerGroupID}
Hiermee kun je een deelnemersgroep inschrijven voor een specifieke uitvoering. Je moet hiervoor de externe ID's (bundleCourseID/learnerGroupID) of UID's* (bundleCourseUID) van de bundeluitvoering en deelnemersgroep gebruiken.
*UID's bestaan niet voor deelnemersgroepen.
POST /unsubscribeBundle/{userID}/{bundleCourseID}
of POST /unsubscribeBundle?userUID={userUID}&bundleCourseUID={bundleCourseUID}
Hiermee kun je een deelnemer uitschrijven van een specifieke uitvoering. Je moet hiervoor de externe ID's (userID/bundleCourseID) of UID's (userUID/bundleCourseUID) van de gebruiker (deelnemer) en bundeluitvoering gebruiken.