Wat zijn API-attributen?


Met API-attributen kun je één of meerdere opties toevoegen aan een cursus(sjabloon) of een dagdeel. Zo'n attribuut heeft verder geen functionele gevolgen en is enkel ter verrijking als je de publieke API gebruikt.


Zo kun je ervoor kiezen om een cursustaal, examentaal of opties toe te voegen welke vervolgens 'mee geschoten' kunnen worden bij een boeking.


Algemeen en waar beschikbaar

Standaard staat deze optie niet aan! Laat deze door Planaday activeren in jouw omgeving

  • Attributen zijn globaal aan te maken bij ‘Beheer -> Instellingen -> Publieke pagina's, API & Portals -> API attributen'

  • Globale attributen zijn te ‘hergebruiken’ bij cursussjablonen, cursussen en dagdelen (onder cursus of sjablonen)

  • Je kan attributen onder een cursussjabloon, cursus en/of dagdeel hangen

  • Attributen kunnen aangemaakt, verwijderd, gekopieerd of gekoppeld worden


Business rules


Er zijn business rules opgesteld. Deze vind je hier.


Generieke API-attributen


Je kunt eerst generieke API-attributen toevoegen en deze vervolgens gebruiken bij een cursus(sjabloon) en/of een dagdeel.

Zodra je later zo'n generiek attribuut aanpast, wordt deze OVERAL waar deze gekoppeld is aangepast, want deze is tenslotte globaal (generiek).


Lees dit artikel hoe een API-attribuut gemaakt wordt en hoe je deze toevoegt.


API-attributen voor cursus


Wil je een specifiek attribuut toevoegen op een cursus, ga dan naar de specifieke cursus(sjabloon) en voeg daar een API-attribuut toe. Als je dat doet, staat deze geheel op zichzelf staand.

Let op: een attribuut kan via deze weg NIET globaal (generiek) gemaakt worden, dit kan alleen via de 'globale route'.


Lees dit artikel hoe een API-attribuut gemaakt wordt en hoe je deze toevoegt.


API-attributen voor dagdeel


Wil je een specifieke attribuut toevoegen op een dagdeel ga dan naar het specifieke dagdeel en voeg daar een API-attribuut toe. Als je dat doet, staat deze geheel op zichzelf staand.

Let op: een attribuut kan via deze weg NIET globaal (generiek) gemaakt worden, dit kan alleen via de 'globale route'.


Lees dit artikel hoe een API-attribuut gemaakt wordt en hoe je deze toevoegt.