○ API calls - Subomgevingen
Deze API calls horen alleen gebruikt te worden als subbeheer is ingesteld voor de betreffende leeromgeving. Deze functionaliteit staat niet standaard aan en heeft een grote impact op hoe het beheer van de leeromgeving werkt. Deze optie kan alleen worden aangezet na contact met aNewSpring. Meer informatie
Deze API calls maken het mogelijk om:
- alle profielen die aan de subomgeving zijn gekoppeld op te halen
- events en subomgevingen (ont)koppelen
- gebruikersgroepen en subomgevingen (ont)koppelen
- templates en subomgevingen (ont)koppelen
- gebruikers en subomgevingen (ont)koppelen
Context
Als subbeheer is aangezet, kan alles dat je in de leeromgeving kunt beheren worden gescheiden per subomgeving.
Een leeromgeving kan meerdere subomgevingen hebben, wat altijd het geval zal zijn als subbeheer is aangezet. Deze subomgevingen zijn verschillende "ingangen" voor de leeromgeving.
Beheerders kunnen beheerrechten hebben voor een of meer subomgevingen en zien alleen de onderdelen die zijn gekoppeld aan de subomgevingen waar ze beheerrechten voor hebben.
De onderdelen die je kunt koppelen aan subomgevingen zijn events, gebruikersgroepen, templates en gebruikers. Profielen kunnen niet worden gekoppeld via de API, maar je kunt wel een lijst ophalen van profielen die aan de subomgeving zijn gekoppeld.
Voor deze onderdelen zijn er meer mogelijkheden met de API, deze vind je hier:
- API calls - Events
- API calls - Gebruikersgroepen
- API calls - Templates en uitvoeringen
- API calls - Gebruikers
- API calls - Profielen
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 subomgevingen is een Reseller. Niet te verwarren met de reseller-rol van gebruikers.
- Een event is een BookableEvent. Niet te verwarren met agendapunten, die in de API "Event" worden genoemd. De API calls in dit supportartikel gaan niet over agendapunten, maar over events.
- Een gebruikersgroep is een Group.
- Een profiel is een SkillProfile.
API calls
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 /getResellerSkillProfiles/{resellerID}
Hiermee kun je alle profielen ophalen die aan de subomgeving zijn gekoppeld. Je moet hiervoor de externe ID van het profiel (skillProfileID) gebruiken.
De API call is alleen beschikbaar wanneer de Profielen functionaliteit ook is ingeschakeld door de Omgevingsbeheerder via de tab Instellingen.
POST requests
POST /addResellerBookableEvents/{resellerID}
Hiermee kun je events koppelen aan een subomgeving. Je moet hiervoor de externe ID van de subomgeving (resellerID) en de externe ID's van de events gebruiken, die je als array kunt sturen in de parameter event, door deze parameter meerdere keren te herhalen met verschillende waardes in één API call.
POST /addResellerGroups/{resellerID}
Hiermee kun je gebruikersgroepen koppelen aan een subomgeving. Je moet hiervoor de externe ID van de subomgeving (resellerID) en de externe ID's van de gebruikersgroepen gebruiken, die je als array kunt sturen in de parameter group, door deze parameter meerdere keren te herhalen met verschillende waardes in één API call.
POST /addResellerTemplates/{resellerID}
Hiermee kun je templates koppelen aan een subomgeving. Je moet hiervoor de externe ID van de subomgeving (resellerID) en de externe ID's van de templates gebruiken, die je als array kunt sturen in de parameter template, door deze parameter meerdere keren te herhalen met verschillende waardes in één API call. In plaats van de externe ID's van templates, kun je ook de UID's van templates gebruiken in de parameter templateUID.
POST /addResellerUsers/{resellerID}
Hiermee kun je gebruikers koppelen aan een subomgeving. Je moet hiervoor de externe ID van de subomgeving (resellerID) en de externe ID's van de gebruikers gebruiken, die je als array kunt sturen in de parameter user, door deze parameter meerdere keren te herhalen met verschillende waardes in één API call. In plaats van de externe ID's van gebruikers, kun je ook de UID's van gebruikers gebruiken in de parameter userUID.
Deze API call is alleen beschikbaar wanneer subbeheer is ingeschakeld voor de omgeving.
POST /deleteResellerBookableEvents/{resellerID}
Hiermee kun je events ontkoppelen van een subomgeving. Je moet hiervoor de externe ID van de subomgeving (resellerID) en de externe ID's van de events gebruiken, die je als array kunt sturen in de parameter event, door deze parameter meerdere keren te herhalen met verschillende waardes in één API call.
POST /deleteResellerGroups/{resellerID}
Hiermee kun je gebruikersgroepen ontkoppelen van een subomgeving. Je moet hiervoor de externe ID van de subomgeving (resellerID) en de externe ID's van de gebruikersgroepen gebruiken, die je als array kunt sturen in de parameter group, door deze parameter meerdere keren te herhalen met verschillende waardes in één API call.
POST /deleteResellerTemplates/{resellerID}
Hiermee kun je templates ontkoppelen van een subomgeving. Je moet hiervoor de externe ID van de subomgeving (resellerID) en de externe ID's van de templates gebruiken, die je als array kunt sturen in de parameter template, door deze parameter meerdere keren te herhalen met verschillende waardes in één API call. In plaats van de externe ID's van templates, kun je ook de UID's van templates gebruiken in de parameter templateUID.
POST /deleteResellerUsers/{resellerID}
Hiermee kun je gebruikers ontkoppelen van een subomgeving. Je moet hiervoor de externe ID van de subomgeving (resellerID) en de externe ID's van de gebruikers gebruiken, die je als array kunt sturen in de parameter user, door deze parameter meerdere keren te herhalen met verschillende waardes in één API call. In plaats van de externe ID's van gebruikers, kun je ook de UID's van gebruikers gebruiken in de parameter userUID.
Deze API call is alleen beschikbaar wanneer subbeheer is ingeschakeld voor de omgeving.
In dit overzicht staat geen API call waarmee je uitvoeringen aan subomgevingen kunt koppelen, omdat je dit alleen kunt doen op het moment dat je een uitvoering aanmaakt (instantieert) van een template. Je kunt hiervoor de API call /instantiate/{templateID}/{courseID} gebruiken, die staat beschreven in dit artikel.