○ API calls - Events
Deze API calls maken het mogelijk om:
- nieuwe events toe te voegen
- eigenschappen van bestaande events te wijzigen
- begeleiders en events te (ont)koppelen
- events en event-activiteiten te (ont)koppelen
Context
Uitvoeringen in aNewSpring bestaan uit activiteiten. Eén zo'n activiteit is de event-activiteit. Meerdere events kunnen aan één event-activiteit gekoppeld worden. Hierdoor krijgen deelnemers de keuze aan welk event ze willen deelnemen.
Events kunnen ook een begeleider hebben. De begeleider kan de eigenschappen van het event wijzigen en deelnemers beoordelen met een score als scoring is ingeschakeld. Het is ook mogelijk om begeleiders aan de hand van aanwezigheid te laten beoordelen, maar alleen als scoring niet is ingeschakeld.
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 event is een bookableEvent. Niet te verwarren met agendapunten, die "event" worden genoemd in de API. De API calls in dit artikel gaan niet over agendapunten.
- Een begeleider is een teacher.
- Een uitvoering is een course.
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 /getBookableEventSubscriptions/{eventID}
of POST /getBookableEventSubscriptions?eventID={eventID}
Hiermee kun je alle inschrijvingen van een event ophalen. Je moet hiervoor de externe ID (eventID) van het event gebruiken.
POST requests
POST /addBookableEvent/{eventID}
Hiermee kun je een nieuw event aanmaken. De externe ID dat het event moet krijgen moet je aangeven als eventID.
POST /updateBookableEvent/{eventID}
Hiermee kun je de eigenschappen van een specifiek event wijzigen. Je moet hiervoor de externe ID van het event gebruiken.
POST /addOrUpdateBookableEvent/{eventID}
Deze call kun je gebruiken als het niet zeker is of een event al bestaat. Als het event al bestaat, gedraagt deze call zich als /updateBookableEvent en worden alleen de bijbehorende parameters geaccepteerd. Als de gebruiker nog niet bestaat, gedraagt deze call zich als /addBookableEvent en worden alleen de daarbij horende parameters geaccepteerd. Je moet hiervoor de externe ID van de gebruiker gebruiken.
POST /addBookableEventTeachers/{eventID}
Hiermee kun je begeleiders aan een specifiek event koppelen. Je moet hiervoor de externe ID (eventID) van de event gebruiken en de external ID's van de gebruikers (begeleiders), die je als array in de parameter user kunt sturen, door dezelfde parameter met verschillende waardes te herhalen. In plaats van de externe ID's van de gebruikers, kun je ook de UID's sturen als array in de parameter userUID.
POST /deleteBookableEventTeachers/{eventID}
Hiermee kun je begeleiders van een specifiek event ontkoppelen. Je moet hiervoor de externe ID (eventID) van de event gebruiken en de external ID's van de gebruikers (begeleiders), die je als array in de parameter user kunt sturen, door dezelfde parameter met verschillende waardes te herhalen. In plaats van de externe ID's van de gebruikers, kun je ook de UID's sturen als array in de parameter userUID.
POST /linkBookableEvent/{eventID}/{courseID}/{activityID}
of POST /linkBookableEvent?eventID={eventID}&courseUID={courseUID}&activityUID={activityUID}
Hiermee kun je een event aan een specifieke event-activiteit van een specifieke uitvoering koppelen. Je moet hiervoor de externe ID (eventID) gebruiken van het event en de externe ID's (courseID/activityID) of UID's (courseUID/activityUID) van de uitvoering en de event-activiteit.
POST /unlinkBookableEvent/{eventID}/{courseID}/{activityID}
of POST /unlinkBookableEvent?eventID={eventID}&courseUID={courseUID}&activityUID={activityUID}
Hiermee kun je een event van een specifieke event-activiteit van een specifieke uitvoering ontkoppelen. Je moet hiervoor de externe ID (eventID) gebruiken van het event en de externe ID's (courseID/activityID) of UID's (courseUID/activityUID) van de uitvoering en de event-activiteit.
POST /subscribeBookableEvent/{userID}/{eventID}
of POST /subscribeBookableEvent?userUID={userUID}&eventUID={eventUID}
Hiermee kun je een deelnemer inschrijven voor een event. Je moet hiervoor de externe ID's (userID/eventID) of UID's (userUID/eventUID) gebruiken van de deelnemer en de event. Als er meerdere activiteiten aan dezelfde event zijn gekoppeld, zul je de externe ID van de uitvoering (courseID) of activiteit (activityID) moeten meesturen om aan te geven voor welke de deelnemer moet worden ingeschreven.
POST /unsubscribeBookableEvent/{userID}/{eventID}
of POST /unsubscribeBookableEvent?userUID={userUID}&eventUID={eventUID}
Hiermee kun je een deelnemer uitschrijven van een event. Je moet hiervoor de externe ID's (userID/eventID) of UID's (userUID/eventUID) gebruiken van de deelnemer en de event.