Deze API calls maken het mogelijk om:

  • gegevens over bestaande templates en uitvoeringen op te halen
  • nieuwe uitvoeringen aan te maken of bestaande te updaten
  • rechten voor begeleiders in te stellen
  • deelnemers en begeleiders te koppelen
  • uitvoeringen te verwijderen
  • templates te kopiëren

Context

In aNewSpring heb je templates die bestaan uit een ontwerp voor het leerpad. Dit ontwerp bestaat uit blokken die alle een eigen set activiteiten hebben. Beheerders kunnen een uitvoering maken van de template. Een template kan meerdere uitvoeringen hebben.

Je kunt deelnemers inschrijven voor een uitvoering en zij kunnen dan de activiteiten doen.

Je kunt ook één begeleidersgroep en één mentorgroep aan de uitvoering koppelen. Deze groepen bevatten (een of meer) gebruikers met de rol van begeleider of mentor. Mentoren kunnen alleen statistieken bekijken. Begeleiders hebben meer rechten.

Bij de meeste types activiteiten, kun je selecteren welke begeleiders de activiteit mogen beoordelen (bijvoorbeeld: open vragen of een inleveropdracht)

Binnen een uitvoering zijn begeleiders aan deelnemers gekoppeld. Op deze manier kunnen begeleiders alleen de gekoppelde deelnemers zien in bijvoorbeeld de statistieken van de cursus.

Supportartikelen:

  • De structuur van aNewSpring
  • Welke activiteiten kan ik gebruiken in een template?
  • Op welke manier kan ik deelnemers inschrijven in een uitvoering?
  • Begeleider toevoegen aan een uitvoering
  • Uitvoering instellingen - Tab: Begeleiders
  • Uitvoering instellingen - Tab: Activiteiten
  • Uitvoering instellingen - Tab: Begeleider en deelnemer koppelen

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 uitvoering is een course.
- Een activiteit wordt soms een coursePart genoemd.
- Een deelnemer is een student.
- Een begeleider is een teacher.
- Een subomgeving is een reseller, niet te verwarren met de reseller-rol.

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 /getTemplates
Hiermee kun je een lijst ophalen van alle gepubliceerde templates die een extern ID hebben. Gearchiveerde templates worden niet meegenomen.

GET /getCourses/{templateID}
Hiermee kun je alle uitvoeringen van een specifieke template ophalen. Je moet hiervoor de externe ID van de template gebruiken.

GET /courseExists/{courseID}
Hiermee kun je nagaan of een specifieke uitvoering al bestaat. Je moet hiervoor de externe ID van de uitvoering gebruiken.

GET /getCourse/{courseID}
Hiermee kun je gegevens ophalen van een specifieke uitvoering. Je moet hiervoor de externe ID van de uitvoering gebruiken.

GET /getStudentSubscriptions/{courseID}
Hiermee kun je een lijst ophalen van alle deelnemers die zijn ingeschreven voor een specifieke uitvoering. Je moet hiervoor de externe ID van de uitvoering gebruiken.

GET /getStudentTeachers/{userID}/{courseID}
Hiermee kun je een lijst ophalen van alle begeleiders van een specifieke deelnemer van een specifieke uitvoering. Je moet hiervoor de externe ID's van de gebruiker (deelnemer) en de uitvoering gebruiken.

GET /getTeacherStudents/{userID}/{courseID}
Hiermee kun je een lijst ophalen van alle deelnemers van een specifieke begeleider van een specifieke uitvoering. Je moet hiervoor de externe ID's van de gebruiker (begeleider) en de uitvoering gebruiken.

POST requests

POST /instantiate/{templateID}/{courseID}
Hiermee kun je een nieuwe uitvoering aanmaken aan de hand van een specifieke template. Je moet hiervoor de externe ID van de template gebruiken en de nieuwe uitvoering krijgt het externe ID dat je aangeeft als courseID.

POST /updateCourse/{courseID}
Hiermee kun je eigenschappen van een bestaande uitvoering wijzigen. Gebruik deze API call ook als je een begeleiders- en/of mentorgroep wilt koppelen.
Je moet hiervoor de externe ID van de uitvoering gebruiken en optioneel ook de externe ID('s) van de begeleider en/of mentorgroep.

POST /setCoursePermissions/{courseID}/{teacherID}
Hiermee kun je begeleidersrechten toekennen (of ontnemen) voor een specifieke uitvoering. Standaard staan alle rechten ingeschakeld. Als dat het geval is, zou je de parameter unset met als waarde true kunnen meesturen om de rechten die een begeleider niet moet hebben te ontnemen.

Deze waardes zijn toegestaan in de permission parameter:
- CourseSettings: Begeleider kan de instellingen van de uitvoering aanpassen.
- EditCalendar: Begeleider kan agendapunten toevoegen.
- EditTeacherStudents: Begeleider kan een specifieke groep deelnemers aanmaken en begeleiden.
- ReceiveStudentMessage: Begeleider kan berichten ontvangen van en versturen aan deelnemers.
- ReceiveCoursePartNotifications: Begeleider ontvangt statistiekenmail, een kopie van cursusnotificaties aan deelnemers en notificaties van discussies en afgeronde geselecteerde activiteiten.
- AssessorPossible: Begeleider kan open vragen, inleveropdrachten en 360° feedback activiteiten beoordelen. Je kunt verder specificeren welke activiteiten begeleiders mogen beoordelen met POST /setActivityPermissions.
Je kunt de rechten meesturen als array door de parameter meerdere keren te herhalen met verschillende waardes in één API call.
Je moet hiervoor de externe ID's van de uitvoering en de gebruiker (deelnemer) gebruiken.

POST /setActivityPermissions/{courseID}/{activityID}/{teacherID}
Hiermee kun je aanzetten (of uitzetten) dat een begeleider een specifieke activiteit mag beoordelen. Dit werkt alleen als de begeleider ook de coursePermission AssessorPossible heeft, die je kunt instellen met POST /setCoursePermissions.
Als permission parameter moet je hiervoor de waarde Assess meesturen.
Je moet hiervoor de externe ID's van de uitvoering, de activiteit en de gebruiker (begeleider) gebruiken.

POST /addTeacherStudents/{courseID}/{teacherID}
Hiermee kun je deelnemers aan een specifieke begeleider koppelen. De begeleider kan alleen deelnemers zien waar die aan gelinkt is. Je moet hiervoor de externe ID's van de uitvoering, de gebruiker (begeleider) en alle gebruikers (deelnemers) gebruiken die je aan de begeleider wilt koppelen. De externe ID's van de deelnemers kun je als array versturen in de parameter student, door deze parameter meerdere keren te herhalen met verschillende waardes in één API call.

POST /deleteTeacherStudents/{courseID}/{teacherID}
Dit werkt hetzelfde als /addTeacherStudents/, maar zal de deelnemers ontkoppelen van de specifieke begeleider.

POST /deleteCourse/{courseID}
Hiermee kun je de uitvoering verwijderen. Dit is alleen mogelijk als er geen actieve deelnemers meer zijn, behalve als je de parameter force met als waarde true meestuurt. Dit kan niet ongedaan worden gemaakt. Je moet hiervoor de externe ID van de uitvoering gebruiken.

POST /copyTemplate/{existing templateID}/{new templateID}
Hiermee kun je een kopie maken van de template.
Templates zijn gekoppeld aan een of meer contentbibliotheken. Meerdere templates kunnen dezelfde contentbibliotheek gebruiken. Je kunt aangeven of de nieuwe template dezelfde contentbibliotheken moet blijven gebruiken of dat je hier ook een kopie van wilt maken door copyContent als true of false in te stellen.
Geef publish als waarde true mee om ook uitvoeringen aan te kunnen maken aan de hand van de gekopieerde template. Als je publish als waarde false meegeeft, zal een gebruiker met de rol van ontwerper de template handmatig moeten publiceren na het doen van eventuele aanpassingen.
Je moet hiervoor de externe ID van de template gebruiken en je moet ook aangeven wat de externe ID van de kopie moet worden.