Algemene uitleg API-attributen

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.

Eerste stappen / nodig

1. Zorg dat er een publieke API is aangemaakt in jouw Planaday. Deze is nodig om vanuit Wordpress Plugin te communiceren met Planaday. Zie ook dit artikel.
2. Activeer de API. Zie ook dit artikel

Business rules

Er zijn business rules opgesteld. Deze vind je hier.

API-attributen activeren

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

API-attribuut structuur

API-attributen hebben de volgende structuur in het systeem:

• label

• omschrijving

• code (gegenereerd door systeem)

• koppeling (tabel/tabel id)

• lijst met waardes, bestaande uit:

  • naam

  • waarde (optioneel)

  • omschrijving (optioneel)

• beschikbaar in API

• verplicht in boeking

• beschikbaar voor communicatie

• heeft financiële gevolgen

• btw tarief

• actief

• bij boeking meerdere waardes toegestaan

Publieke API calls

In de volgende Publieke API calls zullen de API-attributen zichtbaar worden. Voor detail documentatie zie: https://apidocs.planaday.nl

• /booking

• /course/get

• /course/list

• /daypart/get

• /coursetemplates/get

• /coursetemplates/list

Koppelingen

Attributen zitten gekoppeld aan de volgende items:

Dagdeel optie (boeking via API)

Voor elke gekozen dagdeel (daypartid in booking api) zal het attribuut veld gevuld worden met:

• attributen gekoppeld aan de cursus

• attributen gekoppeld aan het specifieke dagdeel

Cursist (persoon ingepland op cursus)

Bij een cursist zal worden geregistreerd welke waardes zijn ingevuld voor de API-attributen per ingepland dagdeel:

• attributen gekoppeld aan de cursus

• attributen gekoppeld aan het specifieke dagdeel

Gevolgde opleiding

Bij een cursist zal worden geregistreerd welke waardes zijn ingevuld voor de API-attributen per dagdeel van de gevolgde opleiding:

• attributen gekoppeld aan de cursus

• attributen gekoppeld aan het specifieke dagdeel