API referentie

Hieronder vindt u een overzicht van alle API (Application Programming Interface)-methodes.

Momenteel wordt API-versie 1.1 gebruikt.

 

confirmAppointment

Vanaf API versie 1.1

Bevestigt een afspraak met een eerder verzonden bevestigingscode. Deze code wordt per e-mail of SMS verzonden naar de klant, afhankelijk van de configuratie. Indien de code juist is wordt de afspraakstatus gewijzigd van PENDING naar CONFIRMED.

Parameters

id Verplicht Id van de afspraak
ConfirmationCode Verplicht Alfa-numerieke waarde die de consument per e-mail of SMS ontvangen heeft.

Return-elementen

Confirmed 1 = success, 0 = failed

Naar boven

getAgenda

Vanaf API versie 1.1

Haalt een specifieke agenda op.

Parameters

Id Verplicht, id van de agenda

Return-elementen

Id
Name Naam van de agenda
DateFormat PHP date() datumnotatie, bijv. "D d/m/Y"
TimeFormat PHP date() tijdnotatie, bijv. "H:i"
AlignGrid Aantal minuten waarop het grid is uitgelijnd. Standaardwaarde is 15.
IsDefault 1 indien deze agenda de hoofdagenda van het bedrijf is, anders 0.

Naar boven

getAgendas

Vanaf API versie 1.1

Haalt alle agenda's van een bedrijf op.

Parameters

Geen

Return-elementen

Id
Name Naam van de agenda
DateFormat PHP date() datumnotatie, bijv. "D d/m/Y"
TimeFormat PHP date() tijdnotatie, bijv. "H:i"
AlignGrid Aantal minuten waarop het grid is uitgelijnd. Standaardwaarde is 15.
IsDefault 1 indien deze agenda de hoofdagenda van het bedrijf is, anders 0.

Naar boven

getAppointment

Vanaf API versie 1.1

Haalt de details van een specifieke afspraak op.

Parameters

Id Verplicht, id van de afspraak

Return-elementen

Id
Name Naam
Description Omschrijving
StartTime Notatie "yyyy-mm-dd hh:mm:ss"
FinishTime Notatie "yyyy-mm-dd hh:mm:ss"
BlockedTime Notatie "yyyy-mm-dd hh:mm:ss"
AppointmentTypeId Id van het afspraaktype
CustomerId Id van de consument
Status Status van de afspraak ( 1 = enabled, 2 = disabled, 3 = deleted )
Label Label van de afspraak ( 1 = pending, 2 = approved, 3 = finished, 4 = cancelled, 5 = in progress )
Resources Lijst met resources die zijn gekoppeld aan de afspraak.
[variabel] De eventuele extra velden die gekoppeld zijn aan de afspraak. Deze velden gebruiken de Key als veldnaam (zie getFields).

Naar boven

getAppointments

Vanaf API versie 1.1

Haalt de afspraken op van een bepaalde agenda. Optioneel kunnen de start en/of einddatum opgegeven worden.

Parameters

AgendaId Verplicht, id van de agenda
CustomerId [Optioneel] Indien gespecificeerd, worden alleen de afspraken van deze klant opgehaald.
AppointmentTypeId [Optioneel] Indien gespecificeerd, worden alleen de afspraken van dit afspraaktype opgehaald.
ResourceId [Optioneel] Indien gespecificeerd, worden alleen de afspraken van deze resource opgehaald.
StartDate Verplicht, notatie "yyyy-mm-dd"
EndDate Verplicht, notatie "yyyy-mm-dd"

Return-elementen

Id
Name Naam
Description Omschrijving
StartTime Notatie "yyyy-mm-dd hh:mm:ss"
FinishTime Notatie "yyyy-mm-dd hh:mm:ss"
BlockedTime Notatie "yyyy-mm-dd hh:mm:ss"
AppointmentTypeId Id van het afspraaktype
CustomerId Id van de klant
CustomerName De volledige naam van de klant (indien van toepassing)
Status Status van de afspraak ( 1 = enabled, 2 = disabled, 3 = deleted )
Label Label van de afspraak ( 1 = pending, 2 = approved, 3 = finished, 4 = cancelled, 5 = in progress )
Resources Lijst met resources die zijn gekoppeld aan de afspraak.
[variabel] De eventuele extra velden die gekoppeld zijn aan de afspraak. Deze velden gebruiken de Key als veldnaam (zie getFields).

Naar boven

getAppointmentType

Vanaf API versie 1.1

Haalt een specifiek afspraaktype op.

Parameters

Id Verplicht, id van het afspraaktype

Return-elementen

Id
Name Naam
Description Omschrijving
SchedulingType Afspraaktype-schema( capacity of resource )
PriceType Prijstype ( 1 = vaste prijs, 2 = vanaf prijs, 3 = niet beschikbaar )
Price Prijs
Duration Lengte van de afspraak, in minuten
MinTimeBeforeAppointment Minimale tijd voor de afspraaktijd, in minuten
MaxTimeBeforeAppointment Maximalen tijd voor de afspraaktijd, in minuten
Buffer Buffertijd die gereserveerd wordt achter de afspraak, in minuten. De totaal geblokte tijd bij het maken van een afspraak is de Duration plus de Buffer.
CanBeBookedByConsumer Geeft aan of dit afspraaktype geboekt kan worden door een consument. ( 1 = boekbaar, 0 = niet boekbaar )
CategoryId Id van de categorie waar dit afspraaktype bij hoort.
Capacity Capaciteit van het afspraaktype, indien Type op capacity staat.

Naar boven

getAppointmentTypes

Vanaf API versie 1.1

Haalt alle afspraaktypes op.

Parameters

Geen

Return-elementen

Id
Name Naam
Description Omschrijving
SchedulingType Afspraaktype-schema( capacity of resource )
PriceType Prijstype ( 1 = vaste prijs, 2 = vanaf prijs, 3 = niet beschikbaar )
Price Prijs
Duration Lengte van de afspraak, in minuten
MinTimeBeforeAppointment Minimale tijd voor de afspraaktijd, in minuten
MaxTimeBeforeAppointment Maximalen tijd voor de afspraaktijd, in minuten
Buffer Buffertijd die gereserveerd wordt achter de afspraak, in minuten. De totaal geblokte tijd bij het maken van een afspraak is de Duration plus de Buffer.
CanBeBookedByConsumer Geeft aan of dit afspraaktype geboekt kan worden door een consument. ( 1 = boekbaar, 0 = niet boekbaar )
CategoryId Id van de categorie waar dit afspraaktype bij hoort.
Capacity Capaciteit van het afspraaktype, indien Type op capacity staat.

Naar boven

getBookableDays

Vanaf API versie 1.1

Haalt de boekbare dagen op van een bepaald afspraaktype en voor een bepaalde resource. Optioneel kan een start en/of einddatum opgegeven worden.

Parameters

AgendaId Verplicht, id van de agenda.
ResourceId, id van de resource waar de beschikbaarheid van gecontroleerd wordt.
AppointmentTypeId Verplicht, id van het afspraaktype waar de beschikbaarheid van gecontroleerd wordt.
StartDate Notatie "yyyy-mm-dd"
EndDate Notatie "yyyy-mm-dd"

Return-elementen

Date Datum, notatie "yyyy-mm-dd"
Month Maand, zonder voorloopnul.
Day Dag, zonder voorloopnul.

Naar boven

getBookableTimes

Vanaf API versie 1.1

Haalt de boekbare tijden op van een bepaald afspraaktype en resource, voor een bepaalde datum. Optioneel kunnen de start en/of eindtijd opgegeven worden.

Parameters

AgendaId Verplicht, id van de agenda.
Date Verplicht, datum waarvan de tijden bepaald moeten worden.
AppointmentTypeId Verplicht, id van het afspraaktype.
ResourceId Id van de resource. Indien niet meegegeven worden de boekbare tijden van alle resources geretourneerd.
StartTime
EndTime

Return-elementen

Date Datum, notatie "yyyy-mm-dd"
StartTime Starttijd, notatie "hh:mm"
EndTime Eindtijd, notatie "hh:mm"
Timestamp Timestamp van de starttijd.
AppointmentTypeId Id van het afspraaktype.
ResourceId Id van de resource, of 0 indien er geen resource gekoppeld is.

Naar boven

getCustomer

Vanaf API versie 1.1

Haalt een specifieke klant op.

Parameters

Id Verplicht, id van de consument.

Return-elementen

Id
AccountNumber Klantnummer
FirstName Voornaam
LastName Achternaam
Insertions Tussenvoegsel
BirthDate Geboortedatum, notatie "yyyy-mm-dd"
Gender Geslacht ( M = man, F = vrouw )
Street Adres
HouseNr Huisnummer, numeriek
HouseNrAddition Toevoeging, zoals A
ZipCode Postcode
City Plaats
Country Land
Phone Telefoon
MobilePhone Mobiele telefoon
Email E-mail adres
Status Status van de consument ( 1 = enabled, 2 = disabled, 3 = deleted )
UpdateTime Datum en tijd waarop de klantgegevens voor het laatst zijn aangepast. (Formaat: yyyy-mm-dd HH:mm:ss)
CreateTime Datum en tijd waarop de klant is aangemaakt: (Formaat: yyyy-mm-dd HH:mm:ss)
[variabel] De eventuele extra velden die gekoppeld zijn aan de klant. Deze velden gebruiken de Key als veldnaam (zie getFields).

Naar boven

getCustomers

Vanaf API versie 1.1

Haalt de gegevens van alle klanten op.

Parameters

Limit Maximaal aantal klanten dat wordt opgehaald. Standaard kunnen met een aanroep maximaal 500 klanten opgehaald worden.
Offset Eerste klant die wordt opgehaald.
UpdatedAfter Haal alleen de gegevens op van de klanten die na dit tijdstip zijn gewijzigd (Formaat: YYYY-MM-DD HH:mm:ss). Als deze parameter wordt gebruikt, kan het resultaat ook verwijderde klanten bevatten. Hiervan zijn alleen de velden Id en Status gevuld. Als deze parameter niet wordt gebruikt, worden de gegevens van alle klanten opgehaald.
Email Als deze parameter wordt gebruikt, worden alleen de gegevens van de klanten met dit e-mailadres opgehaald.
BirthDate Als deze parameter wordt gebruikt, worden alleen de gegevens van de klanten met deze geboortedatum opgehaald (formaat = YYYY-MM-DD)
AccountNumber Als deze parameter wordt gebruikt, worden alleen de gegevens van de klanten met dit klantnummer opgehaald.

Return-elementen

Id
AccountNumber Klantnummer
FirstName Voornaam
LastName Achternaam
Insertions Tussenvoegsel
BirthDate Geboortedatum, notatie "yyyy-mm-dd"
Gender Geslacht ( M = man, F = vrouw )
Street Adres
HouseNr Huisnummer, numeriek
HouseNrAddition Toevoeging, zoals A
ZipCode Postcode
City Plaats
Country Land
Phone Telefoon
MobilePhone Mobiele telefoon
Email E-mail adres
Status Status van de consument ( 1 = enabled, 2 = disabled, 3 = deleted )
UpdateTime Datum en tijd waarop de klantgegevens voor het laatst zijn aangepast. (Formaat: yyyy-mm-dd HH:mm:ss)
CreateTime Datum en tijd waarop de klant is aangemaakt: (Formaat: yyyy-mm-dd HH:mm:ss)
[variabel] De eventuele extra velden die gekoppeld zijn aan de klant. Deze velden gebruiken de Key als veldnaam (zie getFields).

Naar boven

getFields

Vanaf API versie 1.1

Haalt extra velden op voor de registratie en afspraak maken formulieren.

Parameters

AgendaId Verplicht, id van de agenda.
AppointmentTypeId Als je hier het id van een afspraaktype meegeeft, krijg je alleen de velden terug die worden getoond bij een afspraak van het betreffende afspraaktype.

Return-elementen

Id
Label Label van het formulier-element
Key Naam van het veld om te gebruiken in calls naar setCustomer en setAppointment. Deze naam is afgeleid van het label, maar bevat bijvoorbeeld geen spaties.
Type Formuliertype, op welk formulier dit element getoond moet worden volgens de configuratie vanuit de agenda. ( Appointment = afspraak maken formulier, Registration = registratie formulier )
Required Geeft aan of het veld verplicht is ( 1 = verplicht, 0 = niet verplicht )

Naar boven

getResource

Vanaf API versie 1.1

Haalt een specifieke resource op.

Parameters

Id Verplicht, id van de resource

Return-elementen

Id
Name Naam
Phone Telefoon
MobilePhone Mobiele telefoon
Email E-mail adres
Status Status van de resource ( 1 = enabled, 2 = disabled )
Label [Dit veld heeft geen betekenis meer] (numerieke waarde).

Naar boven

getResources

Vanaf API versie 1.1

Haalt alles resources op.

Parameters

Geen

Return-elementen

Id
Name Naam
Phone Telefoon
MobilePhone Mobiele telefoon
Email E-mail adres
Status Status van de resource ( 1 = enabled, 2 = disabled )
Label [Dit veld heeft geen betekenis meer] (numerieke waarde).

Naar boven

loginCustomer

Vanaf API versie 1.1

Logt een Customer in op basis van gebruikersnaam en wachtwoord. Indien de login geslaagd is wordt de Customer geretourneerd.

Parameters

Username Verplicht
Password Verplicht

Return-elementen

Id
FirstName Voornaam
LastName Achternaam
Insertions Tussenvoegsel
BirthDate Geboortedatum, notatie "yyyy-mm-dd"
Gender Geslacht ( m = man, f = vrouw )
Street Adres
HouseNr Huisnummer, numeriek
HouseNrAddition Toevoeging, zoals A
ZipCode Postcode
City Plaats
Country Land
Phone Telefoon
MobilePhone Mobiele telefoon
Email E-mail adres
Status Status van de consument ( 1 = enabled, 2 = disabled, 3 = deleted )

Naar boven

loginCustomerWithFacebook

Vanaf API versie 1.1

Logt een Customer in op basis van zijn FacebookId. Indien de login geslaagd is wordt de Customer geretourneerd.

Parameters

FacebookId Verplicht

Return-elementen

Id
FirstName Voornaam
LastName Achternaam
Insertions Tussenvoegsel
BirthDate Geboortedatum, notatie "yyyy-mm-dd"
Gender Geslacht ( m = man, f = vrouw )
Street Adres
HouseNr Huisnummer, numeriek
HouseNrAddition Toevoeging, zoals A
ZipCode Postcode
City Plaats
Country Land
Phone Telefoon
MobilePhone Mobiele telefoon
Email E-mail adres
Status Status van de consument ( 1 = enabled, 2 = disabled, 3 = deleted )

Naar boven

passwordRecovery

Vanaf API versie 1.1

Verstuurt een e-mail om het wachtwoord van een account opnieuw in te stellen naar een consument.

Parameters

Email Verplicht E-mail adres van de consument.

Return-elementen

Message Bericht met de status van het verzenden.

Naar boven

removeAppointment

Vanaf API versie 1.1

Verwijdert een afspraak.

Parameters

Id Verplicht, id van de afspraak.

Return-elementen

Geen

Naar boven

requiresConfirmation

Vanaf API versie 1.1

Bepaalt of er een bevestigingscode nodig is om een afspraak te boeken. Indien dit zo is, en een afspraak wordt niet bevestigd via de API dan blijft de afspraak op PENDING staan in het systeem.

Deze instelling is een globale instelling van de agenda. U hoeft deze dus maar eenmalig op te halen, en niet bij iedere nieuwe afspraak.

Parameters

Geen

Return-elementen

Required Geeft aan of een bevestiging vereist is ( 1 = ja, 0 = nee ).

Naar boven

setAppointment

Vanaf API versie 1.1

Slaat een afspraak op voor een consument.

Indien er verplichte velden zijn geconfigureerd, te verkrijgen met de getFields API,  dan moet u deze meesturen in deze request.

Parameters

AgendaId Verplicht, id van de agenda.
CustomerId Verplicht, id van de consument.
AppointmentTypeId Verplicht, id van het afspraaktype.
ResourceId id van de geselecteerde resource. Als deze parameter niet wordt gebruikt, kiest het systeem zelf een beschikbare resource
Date Verplicht, datum van de afspraak, notatie "yyyy-mm-dd".
StartTime Verplicht, starttijd van de afspraak, notatie "hh:mm".
EndTime Verplicht, eindtijd van de afspraak, notatie "hh:mm".
Id Optioneel kan het id van een bestaande afspraak worden meegegeven. Dan wordt deze afspraak aangepast. Indien er geen id wordt meegegeven wordt een nieuwe afspraak aangemaakt.
Name Naam
Description Omschrijving
[variabel] Eventuele extra velden zoals verkregen met getFields. Gebruik de Key van een veld als naam voor de parameter.

Return-elementen

Id
Status Status van de afspraak. ( 1 = pending, 2 = approved, 3 = finished, 4 = cancelled, 5 = in progress ). Indien de status 1 is ( pending ) dan moet u deze naar alle waarschijnlijkheid nog bevestigen. Zie hiervoor de requiresConfirmation en confirmAppointment API.

Naar boven

setCustomer

Vanaf API versie 1.1

Slaat een klant op.

Parameters

id Indien een id wordt meegegeven wordt een bestaande consument aangepast, anders wordt een nieuwe consument aangemaakt.
AccountNumber Klantnummer
FirstName Verplicht Voornaam
LastName Verplicht Achternaam
Insertions Tussenvoegsel
BirthDate Geboortedatum, notatie "yyyy-mm-dd"
Gender Geslacht ( M = man, F = vrouw )
Street Straat
HouseNr Huisnummer
HouseNrAddition Toevoeging, bijv. A.
ZipCode Postcode
City Stad
Country Land
Phone Telefoonnummer. Indien dit veld niet leeg is, dient het een geldig telefoonnnummer te bevatten.
MobilePhone Mobiel telefoonnummer. Indien dit veld niet leeg is, dient het een geldig mobiel nummer te bevatten.
Email Verplicht, e-mail adres
Status Status van de consument ( 1 = enabled, 2 = disabled, 3 = deleted )
[variabel] Eventuele extra velden zoals verkregen met getFields. Gebruik de Key van een veld als naam voor de parameter
Username Gebruikersnaam voor het account waarmee de klant kan inloggen om zijn/haar afspraken te beheren. Gebruikersaccounts kunnen alleen worden aangemaakt voor nieuwe klanten. Voor bestaande klanten wordt deze parameter genegeerd. Als u geen gebruikersaccount wilt aanmaken, dan laat u deze parameter weg.
Password Het wachtwoord voor het gebruikersaccount. Dit wachtwoord dient te bestaan uit minimaal 6 tekens. Deze parameter is verplicht als u de parameter Username gebruikt om een gebruikersaccount aan te maken.

Return-elementen

Id
Status Status van de consument ( 1 = enabled, 2 = disabled, 3 = deleted )

Naar boven