API-attribuut toevoegen / details

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

Afhankelijk van welke keuzes je maakt in het scherm bij het maken of wijzigen van een API-attribuut komen er meer of minder opties in het scherm:

Opties bij het maken of wijzigen van een API-attribuut.

API-attribuut toevoegen

Indien API-attributen actief zijn, kun je:

1. Een API-attribuut toevoegen via ‘Beheer -> Instellingen -> Publieke pagina's, API & Portals -> API attributen'.
2. Deze per cursus(sjabloon) of dagdeel toevoegen.

Tip: maak globale/generieke API-attributen via punt 1. Het voordeel hiervan is dat je de waardes voor alle gekoppelde API-attributen eenvoudig achteraf te wijzigen zijn. Het voordeel hiervan is dat je een optie makkelijk kunt hernoemen en makkelijker de prijzen kan aanpassen.

API attribuut overnemen

Werkwijze

Hieronder staat vermeld wanneer je dit per cursus(sjabloon) of dagdeel wil doen.

1. Kies cursus(sjabloon) of dagdeel
2. Klik op 'API attribuut toevoegen' (button)
3. Kies een attribuut uit de lijst bovenaan bij 'Selecteer attribuut' en kies voor 'Kopieer'

De API-attribuut is meteen gekoppeld!

Stap 3 werkwijze API-attribuut overnemen in een cursus(sjabloon) of dagdeel.

Op cursus niveau

Kies enkel voor deze optie als je wil dat de attributen beschikbaar zijn voor de gehele cursus.

Op dagdeel niveau

Kies enkel voor deze optie als je wil dat de attributen enkel beschikbaar zijn voor dit betreffende dagdeel. Bijvoorbeeld als je uitvraagt of iemand wel of niet extra wil betalen voor extra begeleiding voor die specifieke dagdeel o.i.d.

API-attribuut loskoppelen

Gekoppelde attributen zijn enkel te wijzigen via  ‘Beheer -> Instellingen -> Publieke pagina's, API & Portals -> API attributen'.

Je kunt ze bij een cursus(sjabloon) of dagdeel wel loskoppelen en vervolgens weer aanpassen. In dat geval zijn deze enkel voor die cursus of dat dagdeel beschikbaar.

Werkwijze

1. Ga naar het dagdeel of cursus(sjabloon). 
2. Kies rechts voor 'API-attributen'
3. Klik op 'los koppelen' of 'wijzigen

Loskoppelen of wijzigen van een API-attribuut.

Business rules

Er zijn business rules opgesteld. Deze vind je hier.