Deze API calls maken het mogelijk om:

  • na te gaan of een toegangscodegroep bestaat
  • na te gaan of een toegangscode voor een gebruiker bestaat in een groep
  • nieuwe toegangscodegroepen toe te voegen
  • nieuwe toegangscodes te genereren of toe te voegen (optioneel ook gekoppeld aan een gebruiker)
  • toegangscodes te verwijderen
  • toegangscodegroepen te verwijderen

Context

Er zijn toegangscodegroepen in aNewSpring. Toegangscodegroepen kunnen aan een of meerdere uitvoeringen zijn gekoppeld. Toegangscodegroepen bevatten toegangscodes.

Er zijn twee soorten toegangscodes.

  • Algemene toegangscodes die deelnemers kunnen gebruiken om een account aan te maken.
  • Examentoegangscodes die deelnemers gebruiken om een examen te doen (of bijvoorbeeld om een evaluatie in te vullen). Dit kan alleen bij Test & Assess uitvoeringen en deelnemers kunnen deze codes alleen gebruiken door middel van een speciale link (omgevings-URL + /exams).

Examentoegangscodes kunnen van tevoren aan deelnemersaccounts worden gekoppeld. Als dit niet wordt gedaan, zal de gebruiker eerst wat gegevens moeten invullen om een account aan te maken. Na het inloggen opent direct de activiteit.

Als de deelnemer een algemene toegangscode heeft, kan de deelnemer daarmee een account aanmaken die dan automatisch wordt ingeschreven voor de uitvoering(en) die is/zijn gekoppeld aan de toegangscodegroep.

Supportartikelen:

  • Hoe maak ik toegangscodes aan?

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 subomgeving is een reseller.
  • Een uitvoering is een course.
  • Een toegangscode is een accessCode.
  • Een toegangscodegroep is een accessCodeGroup.

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 /accessCodeGroupExists/{groupID}
Hiermee kun je nagaan of een toegangscodegroep al bestaat. Je moet hiervoor de externe ID van de toegangscodegroep gebruiken.

Alleen toegangscodegroepen die via de API zijn aangemaakt, kunnen een externe ID hebben. Deze externe ID is niet zichtbaar in de interface van aNewSpring.

GET /accessCodeExists/{groupID}/{userID}
Hiermee kun je nagaan of er al een toegangscodegroep voor een specifieke deelnemer bestaat in een specifieke toegangscodegroep. Je moet hiervoor de externe ID's van de toegangscodegroep en gebruiker (deelnemer) gebruiken.

Alleen toegangscodegroepen die via de API zijn aangemaakt, kunnen een externe ID hebben. Deze externe ID is niet zichtbaar in de interface van aNewSpring.

POST requests

POST /addAccessCodeGroup/{groupID}
Hiermee kun je een nieuwe toegangscodegroep toevoegen. De toegangscodegroep krijgt de externe ID die je aangeeft als groupID. De course parameter moet de externe ID's bevatten van de uitvoeringen waar de toegangscodes in deze groep toegang toe moeten geven, welke je als array in de parameter kunt meesturen door deze meerdere keren te herhalen met verschillende waardes in één API call.

POST /createAccessCodes/{groupID}
Hiermee kun je nieuwe toegangscodes genereren en toevoegen aan een specifieke toegangscodegroep. Je moet hiervoor de externe ID van de toegangscodegroep gebruiken.

Alleen toegangscodegroepen die via de API zijn aangemaakt, kunnen een externe ID hebben. Deze externe ID is niet zichtbaar in de interface van aNewSpring.

POST /addAccessCodes/{groupID}
Hiermee kun je voorgedefinieerde toegangscodes toevoegen aan een specifieke toegangscodegroep. Je kunt de toegangscodes als array meesturen in de parameter code, door deze parameter meerdere keren te herhalen met verschillende waardes in één API call.
Je moet hiervoor de externe ID van de toegangscodegroep gebruiken.

Alleen toegangscodegroepen die via de API zijn aangemaakt, kunnen een externe ID hebben. Deze externe ID is niet zichtbaar in de interface van aNewSpring.

POST /addAccessCode/{groupID}/{userID}
Hiermee kun je een voorgedefineerde toegangscode voor een specifieke deelnemer toevoegen aan een specifieke toegangscodegroep. Dit werkt alleen met examentoegangscodes. Je moet hiervoor de externe ID's van de toegangscodegroep en van de gebruiker (deelnemer) gebruiken.

Alleen toegangscodegroepen die via de API zijn aangemaakt, kunnen een externe ID hebben. Deze externe ID is niet zichtbaar in de interface van aNewSpring.

POST /deleteAccessCode/{code}
Hiermee kun je een specifieke toegangscode verwijderen. Voor deze API call heb je geen externe ID's nodig, maar de betreffende toegangscode.

POST /deleteAccessCodeGroup/{groupID}
Hiermee kun je een specifieke toegangscodegroep verwijderen. Dit kan niet ongedaan worden gemaakt. Je moet hiervoor de externe ID van de toegangscodegroep gebruiken.

Alleen toegangscodegroepen die via de API zijn aangemaakt, kunnen een externe ID hebben. Deze externe ID is niet zichtbaar in de interface van aNewSpring.