Deze API calls maken het mogelijk om:

  • gegevens over bestaande profielen op te halen
  • na te gaan aan welke profielen een deelnemer is gekoppeld
  • deelnemers aan profielen te koppelen of te ontkoppelen

Context

aNewSpring heeft profielen en competenties. Door middel van een profiel kun je competenties aan een deelnemer koppelen. De deelnemer kan de voortgang op de competenties per profiel zien.

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 aNeSpring.

  • Een profiel is een skill profile.

API calls

De skill profile API calls zijn alleen zichtbaar wanneer de profielen 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 /getSkillProfiles
Hiermee kun je een lijst ophalen van alle gepubliceerde profielen.

GET /getStudentSkillProfiles/{userID}
of GET /getStudentSkillProfiles?userUID={userUID}
Hiermee kun je alle profielen ophalen waar een gebruiker aan gekoppeld is. Je moet hiervoor de externe ID (userID) of UID (userUID) van de gebruiker (deelnemer) gebruiken.

POST requests

POST /addSkillProfileUsers/{skillProfileID}
of POST /addSkillProfileUsers?skillProfileUID={skillProfileUID}
Hiermee kun je gebruikers aan een bestaand profiel koppelen. Je moet hiervoor de externe ID van het profiel en de gebruikers gebruiken. De externe ID's van de gebruikers kun je als array meegeven 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 de gebruikers, kun je ook de UID's van de gebruikers gebruiken als array in de parameter userUID.

POST /deleteSkillProfileUsers/{skillProfileID}
of POST /deleteSkillProfileUsers?skillProfileUID={skillProfileUID}
Hiermee kun je gebruikers van een bestaand profiel ontkoppelen. Je moet hiervoor de externe ID van het profiel en de gebruikers gebruiken. De externe ID's van de gebruikers kun je als array meegeven 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 de gebruikers, kun je ook de UID's van de gebruikers gebruiken als array in de parameter userUID.