Settings Dictionary

Met de instellingen die toe zijn te voegen aan de widget kan je aanpassingen maken aan de look & feel van de Online Appointment.

Widget code

<oa-widget
    settings='{
          "token": "1x1111x-x1x1-1111-xx1x-111x1111x111",
          "wizard": { "active": false, "navigation": "top" },
          "calendarStartDay": "0",
          "sendMail": true,
          "showMailResponse": true
        }'
        >
</oa-widget>

Dictionary

naam

verplicht

standaard waarde

uitleg

settings

ja

het oa widget component

setting attribute, dit regelt onder andere de look & feel van de Online Appointment

settings='{}'

Hoewel de settings als JSON object is opgemaakt, moeten we deze hier in single quotes doorgeven.

naam

verplicht

standaard waarde

uitleg

token

ja

"no token present"

voer hier je token

string

maak een component token

"token": "1x1111x-x1x1-1111-xx1x-111x1111x111"

naam

verplicht

standaard waarde

uitleg

Wizard

nee

geef aan of de Online Appointment in 1 lang formulier of opgesplitst in 3 delen getoond moet worden

→ active

ja

false

boolean

true = toon wizard

false = toon geen wizard

→ navigation

nee

top

string

top = navigatie bovenaan formulier

bottom = navigatie onderaan formulier

both = navigation boven aan en onderaan formulier

none = geen navigatie

"wizard": {
  "active": false
  "navigation": "top"
}

naam

verplicht

standaard waarde

uitleg

calendarStartDate

nee

"0"

hiermee kun je aangeven met welke dag van de week de getoonde kalender moet starten

string

0 = zondag

1 = maandag

2 = dinsdag

3 = woensdag

4 = donderdag

5 = vrijdag

6 = zaterdag

"calendarStartDay": "0"

naam

verplicht

standaard waarde

uitleg

testMode

nee

toon een testMode alert bovenaan de website om aan te geven dat er aan gewerkt wordt

→ active

ja

false

boolean

true = toon alert

false = toon geen alert

→ text

nee

"Momenteel werken we aan deze website"

string

"testMode": {
  "active": true,
  "text": "Alert Dialog tekst"
}

testMode overschrijft de sendEmail property met false. in testMode wordt er geen mail verzonden aan de client/invuller van de Online Appointment

naam

verplicht

standaard waarde

uitleg

debugMode

nee

toon een debugMode alert bovenaan de website om aan te geven dat de developer met de website bezig is, geeft de mogelijkheid om console - logs te tonen die door de OA widget developers zijn aangegeven

→ active

ja

false

boolean

true = toon alert

false = toon geen alert

→ text

nee

"LET OP! DEVELOPER MODE"

string

→ method

nee

"clidetrskwxz"

string

c = clear() - toont niet

l = log()

i = info()

d = debug()

e = error()

t = table()

r = response() → API

s = success() → API

k = kalendar()

w = warn()

x = trace()

z = dir()

"debugMode": {
  "active": false,
  "text": "LET OP! DEVELOPER MODE",
  "method":"clidetrskwxz"
}

In debugMode kunnen console logs getoond worden, oa API gegevens.
Zet debugMode uit in de live omgeving

naam

verplicht

standaard waarde

uitleg

sendMail

nee

false

Een bevestiging email versturen

boolean

true = verstuur de OA gegevens in een email aan de invuller van OA, en naar het bedrijf

false = verstuur de OA gegevens in een email alleen aan het bedrijf, en niet naar de invuller van OA

"sendMail": false

naam

verplicht

standaard waarde

uitleg

showMailResponse

nee

false

de bevestiging gegevens ook tonen op de bedankt pagina.

boolean

true = toon de gegevens

false = toon de bedankt pagina zonder gegevens

"showMailResponse": false

naam

verplicht

standaard waarde

uitleg

APILocation

nee

"nl"

hiermee kun je aangeven welke API locatie gebruikt moet worden.

string

nl = voor PROD1 server

eu = voor PROD2 server

vip = vip klant server

voor OA developers

dev = developer server

local-dev = lokaal testen op dev server

local-local = lokaal testen op local server

"APILocation": "nl"

Controleer je instellingen of deze valide JSON genereert, gebruik hiervoor de string/JSON binnen de {} accolades. JSON validator: https://jsonlint.com/

Gerelateerde artikelen

autoflex10
online-afspraak
autoflex9