Deze API calls maken het mogelijk om:

  • na te gaan of een agendapunt al bestaat
  • een nieuw agendapunt toe te voegen
  • gegevens van een bestaand agendapunt aan te passen
  • agendapunten te verwijderen

Context

Uitvoeringen in aNewSpring kunnen een agenda-widget hebben met daarin agendapunten. Dit kunnen bijeenkomsten of examens zijn. Een agendapunt heeft een begin- en einddatum/tijd. Een summary (dat is de titel van het agendapunt) en een beschrijving. De summary is altijd verplicht, de beschrijving is optioneel.

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 agendapunt is een event. Niet te verwarren met "events" die in de API BookableEvent worden genoemd.
  • De externe ID van een agendapunt heet UID. Niet te verwarren met echte UID's. Agendapunten hebben op het moment alleen een extern ID en nog geen automatisch gegenereerd UID.

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 /getEvents
Hiermee haal je een lijst op van alle agendapunten.

GET /eventExists/{UID}
Hiermee kun je nagaan of een specifiek agendapunt al bestaat. Je moet hiervoor de externe ID van het agendapunt gebruiken.

Alleen agendapunten 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 /addEvent/{courseID}/{UID}
of POST /addEvent?courseUID={courseUID}&UID={UID}

Hiermee kun je een nieuw agendapunt aanmaken voor een specifieke uitvoering. Er zijn twee types: Meeting (bijeenkomst) en Exam (examen). Je moet ook de summary instellen, dat is de titel van het agendapunt.
Je moet hiervoor de externe ID (courseID) of UID (courseUID) van de uitvoering gebruiken en het agendapunt krijgt de externe ID die je aangeeft als UID.

POST /updateEvent/{UID}
Hiermee kun je de eigenschappen van een bestaand agendapunt aanpassen. Je moet hiervoor de externe ID van het agendapunt gebruiken.

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

POST /deleteEvent/{UID}
Hiermee kun je een bestaand agendapunt verwijderen. Je moet hiervoor de externe ID van het agendapunt gebruiken.

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

POST /deleteCourseEvents/{courseID}
of POST /deleteCourseEvents?courseUID={courseUID}
Hiermee kun je alle agendapunten van een specifieke uitvoering verwijderen. Je moet hiervoor de externe ID (courseID) of UID (courseUID) van de uitvoering gebruiken.