confirmAppointment

1.1 Afspraken

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
integer
Id van de afspraak
verplicht
ConfirmationCode
integer
Alfa-numerieke waarde die de consument per e-mail of SMS ontvangen heeft.
verplicht

Response

Confirmed
integer

Mogelijke waarden: 1 success0 failed

Naar boven

getAppointment

1.1 Afspraken

Haalt de details van een specifieke afspraak op.

Parameters

Id
integer
Id van de afspraak
verplicht

Response

Id
integer
Id van de afspraak
Name
string
Naam
Description
string
Omschrijving
StartTime
date
Starttijd van de afspraak
Notatie: yyyy-mm-dd hh:mm:ss
FinishTime
date
Eindtijd van de afspraak
Notatie: yyyy-mm-dd hh:mm:ss
BlockedTime
date
Eindtijd van de afspraak inclusief eventuele buffertijd
Notatie: yyyy-mm-dd hh:mm:ss
Capacity
integer
Het aantal personen bij de afspraak. In de meeste gevallen zal dit de waarde 1 hebben; alleen voor groepsafspraken heeft dit een hogere waarde
AppointmentTypeId
integer
Id van het appointmentType
CustomerId
integer
Id van de customer
CustomerName
string
De volledige naam van de customer (indien van toepassing)
Status
string
Status van de afspraak

Mogelijke waarden: 1 enabled2 disabled3 deleted

Label
string
Label van de afspraak

Mogelijke waarden: 1 pending2 approved3 finished4 cancelled5 in progress

Resources
string
Lijst met resources die zijn gekoppeld aan de afspraak.
[variabel]
string
De eventuele extra velden die gekoppeld zijn aan de afspraak. Deze velden gebruiken de Key als veldnaam (zie getFields).

Naar boven

getAppointments

1.1 Afspraken

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

Parameters

AgendaId
integer
Id van de agenda
verplicht
StartDate
yyyy-mm-dd
Startdatum
verplicht
EndDate
yyyy-mm-dd
Einddatum
verplicht
CustomerId
integer
Indien gespecificeerd, worden alleen de afspraken van deze customer opgehaald.
AppointmentTypeId
integer
Indien gespecificeerd, worden alleen de afspraken van dit appointmentType opgehaald.
ResourceId
integer
Indien gespecificeerd, worden alleen de afspraken van deze resource opgehaald.
IncludeCancelled
integer
Als dit de waarde 1 heeft, worden ook de geannuleerde afspraken opgehaald. Standaard worden alleen de actieve afspraken opgehaald.

Response

Id
integer
Name
string
Naam
Description
string
Omschrijving
StartTime
date
Starttijd van de afspraak
Notatie: yyyy-mm-dd hh:mm:ss
FinishTime
date
Eindtijd van de afspraak
Notatie: yyyy-mm-dd hh:mm:ss
BlockedTime
date
Eindtijd van de afspraak inclusief eventuele buffertijd
Notatie: yyyy-mm-dd hh:mm:ss
Capacity
integer
Het aantal personen bij de afspraak. In de meeste gevallen zal dit de waarde 1 hebben; alleen voor groepsafspraken heeft dit een hogere waarde.
AppointmentTypeId
integer
Id van het appointmentType
CustomerId
integer
Id van de customer
CustomerName
string
De volledige naam van de customer (indien van toepassing)
Status
string
Status van de afspraak

Mogelijke waarden: 1 enabled2 disabled3 deleted

Label
string
Label van de afspraak

Mogelijke waarden: 1 pending2 approved3 finished4 cancelled5 in progress

Resources
string
Lijst met resources die zijn gekoppeld aan de afspraak.
[variabel]
string
De eventuele extra velden die gekoppeld zijn aan de afspraak. Deze velden gebruiken de Key als veldnaam (zie getFields).

Naar boven

removeAppointment

1.1 Afspraken

Verwijdert een afspraak.

Parameters

Id
integer
Id van de afspraak.
verplicht

Response

Geen

Naar boven

setAppointment

1.1 Afspraken

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
integer
Id van de agenda.
verplicht
CustomerId
integer
Id van de customer.
verplicht
AppointmentTypeId
integer
Id van het appointmentType.
verplicht
ResourceId
integer
Id van de geselecteerde resource. Als deze parameter niet wordt gebruikt, kiest het systeem zelf een beschikbare resource
Date
yyyy-mm-dd
Datum van de afspraak
verplicht
StartTime
hh:mm
Starttijd van de afspraak
verplicht
EndTime
hh:mm
Eindtijd van de afspraak
verplicht
Id
integer
Optioneel kan het id van een bestaande appointment worden meegegeven. Dan wordt deze afspraak aangepast. Indien er geen id wordt meegegeven wordt een nieuwe afspraak aangemaakt.
Name
string
Naam
Description
string
Omschrijving
[variabel]
string
Eventuele extra velden zoals verkregen met getFields. Gebruik de Key van een veld als naam voor de parameter.

Response

Id
integer
Status
integer
Status van de afspraak.

Mogelijke waarden: 1 pending2 approved3 finished4 cancelled5 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

getAgenda

1.1 Algemeen

Haalt een specifieke agenda op.

Parameters

Id
integer
Id van de agenda
verplicht

Response

Id
integer
Name
string
Naam van de agenda
DateFormat
date
PHP date() datumnotatie, bijv. D d/m/Y
TimeFormat
date
PHP date() tijdnotatie, bijv. H:i
AlignGrid
integer
Aantal minuten waarop het grid is uitgelijnd. Default: 15
IsDefault
integer

Mogelijke waarden: 1 indien deze agenda de hoofdagenda van het bedrijf is0 Secundaire agenda

Naar boven

getAgendas

1.1 Algemeen

Haalt alle agenda's van een bedrijf op.

Parameters

Geen

Response

Id
integer
Name
string
Naam van de agenda
DateFormat
date
PHP date() datumnotatie, bijv. D d/m/Y
TimeFormat
date
PHP date() tijdnotatie, bijv. H:i
AlignGrid
integer
Aantal minuten waarop het grid is uitgelijnd. Default: 15
IsDefault
integer

Mogelijke waarden: 1 indien deze agenda de hoofdagenda van het bedrijf is0 Secundaire agenda

Naar boven

getAppointmentType

1.1 Algemeen

Haalt een specifiek afspraaktype op.

Parameters

Id
integer
Id van het afspraaktype
verplicht

Response

Id
integer
Name
string
Naam
Description
string
Omschrijving
SchedulingType
string
Afspraaktype-schema

Mogelijke waarden: capacity resource

PriceType
integer
Prijstype

Mogelijke waarden: 1 vaste prijs2 vanaf prijs3 niet beschikbaar

Price
float
Prijs
Duration
integer
Lengte van de afspraak, in minuten
MinTimeBeforeAppointment
integer
Minimale tijd voor de afspraaktijd, in minuten
MaxTimeBeforeAppointment
integer
Maximalen tijd voor de afspraaktijd, in minuten
Buffer
integer
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
integer
Geeft aan of dit afspraaktype geboekt kan worden door een consument.

Mogelijke waarden: 1 boekbaar0 niet boekbaar

CategoryId
integer
Id van de category waar dit appointmentType bij hoort.
Capacity
integer
Capaciteit van het appointmentType, indien Type op capacity staat.

Naar boven

getAppointmentTypes

1.1 Algemeen

Haalt alle afspraaktypes op.

Parameters

Geen

Response

Id
integer
Name
string
Naam
Description
string
Omschrijving
SchedulingType
string
Afspraaktype-schema

Mogelijke waarden: capacity resource

PriceType
integer
Prijstype

Mogelijke waarden: 1 vaste prijs2 vanaf prijs3 niet beschikbaar

Price
float
Prijs
Duration
integer
Lengte van de afspraak, in minuten
MinTimeBeforeAppointment
integer
Minimale tijd voor de afspraaktijd, in minuten
MaxTimeBeforeAppointment
integer
Maximalen tijd voor de afspraaktijd, in minuten
Buffer
integer
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
integer
Geeft aan of dit afspraaktype geboekt kan worden door een consument.

Mogelijke waarden: 1 boekbaar0 niet boekbaar

CategoryId
integer
Id van de category waar dit appointmentType bij hoort.
Capacity
integer
Capaciteit van het appointmentType, indien Type op capacity staat.

Naar boven

getResource

1.1 Algemeen

Haalt een specifieke resource op.

Parameters

Id
integer
Id van de resource
verplicht

Response

Id
integer
Name
string
Naam
Phone
string
Telefoon
MobilePhone
string
Mobiele telefoon
Email
string
E-mail adres
Status
integer
Status van de resource

Mogelijke waarden: 1 enabled2 disabled

.
Label
integer
[Dit veld heeft geen betekenis meer].

Naar boven

getResources

1.1 Algemeen

Haalt alles resources op.

Parameters

Geen

Response

Id
integer
Name
string
Naam
Phone
string
Telefoon
MobilePhone
string
Mobiele telefoon
Email
string
E-mail adres
Status
integer
Status van de resource

Mogelijke waarden: 1 enabled2 disabled

.
Label
integer
[Dit veld heeft geen betekenis meer].

Naar boven

requiresConfirmation

1.1 Algemeen

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

Response

Required
string
Geeft aan of een bevestiging vereist is

Mogelijke waarden: 1 ja0 nee

.

Naar boven

getBookableDays

1.1 Beschikbaarheid

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
integer
Id van de agenda.
verplicht
AppointmentTypeId
integer
id van het appointmentType waar de beschikbaarheid van gecontroleerd wordt.
verplicht
ResourceId
integer
Id van de resource waar de beschikbaarheid van gecontroleerd wordt.
StartDate
yyyy-mm-dd
Startdatum
EndDate
yyyy-mm-dd
Einddatum

Response

Date
integer
Datum
Notatie: yyyy-mm-dd
Month
integer
Maand, zonder voorloopnul.
Day
integer
Dag, zonder voorloopnul.

Naar boven

getBookableTimes

1.1 Beschikbaarheid

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
integer
Id van de agenda.
verplicht
Date
date
Datum waarvan de tijden bepaald moeten worden.
verplicht
AppointmentTypeId
integer
Id van het appointmentType.
verplicht
ResourceId
integer
Id van de resource. Indien niet meegegeven worden de boekbare tijden van alle resources geretourneerd.
StartTime
date
Starttijd hh:mm of voor multi-day slots yyyy-mm-dd hh:mm
EndTime
date
Eindtijd hh:mm of voor multi-day slots yyyy-mm-dd hh:mm

Response

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

Naar boven

getCustomer

1.1 Klanten

Haalt een specifieke klant op.

Parameters

Id
integer
Id van de customer.
verplicht

Response

Id
integer
AccountNumber
string
Klantnummer
FirstName
string
Voornaam
LastName
string
Achternaam
Insertions
string
Tussenvoegsel
BirthDate
date
Geboortedatum
Notatie: yyyy-mm-dd
Gender
string
Geslacht

Mogelijke waarden: M manF vrouw

Street
string
Adres
HouseNr
integer
Huisnummer
HouseNrAddition
string
Toevoeging, zoals A
ZipCode
string
Postcode
City
string
Plaats
Country
string
Land
Phone
string
Telefoon
MobilePhone
string
Mobiele telefoon
Email
string
E-mail adres
Status
integer
Status van de consument

Mogelijke waarden: 1 enabled2 disabled3 deleted

UpdateTime
date
Datum en tijd waarop de klantgegevens voor het laatst zijn aangepast.
Notatie: yyyy-mm-dd HH:mm:ss
CreateTime
date
Datum en tijd waarop de klant is aangemaakt:
Notatie: yyyy-mm-dd HH:mm:ss
[variabel]
string
De eventuele extra velden die gekoppeld zijn aan de klant. Deze velden gebruiken de Key als veldnaam (zie getFields).

Naar boven

getCustomers

1.1 Klanten

Haalt de gegevens van alle klanten op.

Parameters

Limit
integer
Maximaal aantal klanten dat wordt opgehaald. Standaard kunnen met een aanroep maximaal 500 klanten opgehaald worden.
Offset
integer
Eerste klant die wordt opgehaald.
UpdatedAfter
date
Haal alleen de gegevens op van de klanten die na dit tijdstip zijn gewijzigd

Notatie: 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
string
Als deze parameter wordt gebruikt, worden alleen de gegevens van de klanten met dit e-mailadres opgehaald.
BirthDate
date
Als deze parameter wordt gebruikt, worden alleen de gegevens van de klanten met deze geboortedatum opgehaald

Notatie: YYYY-MM-DD

AccountNumber
string
Als deze parameter wordt gebruikt, worden alleen de gegevens van de klanten met dit klantnummer opgehaald.

Response

Id
integer
AccountNumber
string
Klantnummer
FirstName
string
Voornaam
LastName
string
Achternaam
Insertions
string
Tussenvoegsel
BirthDate
date
Geboortedatum
Notatie: yyyy-mm-dd
Gender
string
Geslacht

Mogelijke waarden: M manF vrouw

Street
string
Adres
HouseNr
integer
Huisnummer
HouseNrAddition
string
Toevoeging, zoals A
ZipCode
string
Postcode
City
string
Plaats
Country
string
Land
Phone
string
Telefoon
MobilePhone
string
Mobiele telefoon
Email
string
E-mail adres
Status
integer
Status van de consument

Mogelijke waarden: 1 enabled2 disabled3 deleted

UpdateTime
date
Datum en tijd waarop de klantgegevens voor het laatst zijn aangepast.
Notatie: yyyy-mm-dd HH:mm:ss
CreateTime
date
Datum en tijd waarop de klant is aangemaakt:
Notatie: yyyy-mm-dd HH:mm:ss
[variabel]
string
De eventuele extra velden die gekoppeld zijn aan de klant. Deze velden gebruiken de Key als veldnaam (zie getFields).

Naar boven

getFields

1.1 Klanten

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

Parameters

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

Response

Id
integer
Label
string
Label van het formulier-element
Key
string
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
string
Formuliertype, op welk formulier dit element getoond moet worden volgens de configuratie vanuit de agenda.

Mogelijke waarden: Appointment afspraak maken formulierRegistration registratie formulier

Required
integer
Geeft aan of het veld verplicht is

Mogelijke waarden: 1 verplicht0 niet verplicht

Naar boven

loginCustomer

1.1 Klanten

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

Parameters

Username
integer
Gebruikersnaam
verplicht
Password
integer
Wachtwoord
verplicht

Response

Id
integer
FirstName
string
Voornaam
LastName
string
Achternaam
Insertions
string
Tussenvoegsel
BirthDate
date
Geboortedatum
Notatie: yyyy-mm-dd
Gender
string
Geslacht

Mogelijke waarden: m manf vrouw

Street
string
Adres
HouseNr
integer
Huisnummer
HouseNrAddition
string
Toevoeging, zoals A
ZipCode
string
Postcode
City
string
Plaats
Country
string
Land
Phone
string
Telefoon
MobilePhone
string
Mobiele telefoon
Email
string
E-mail adres
Status
integer
Status van de consument

Mogelijke waarden: 1 enabled2 disabled3 deleted

Naar boven

loginCustomerWithFacebook

1.1 Klanten

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

Parameters

FacebookId
integer
Facebook gebruiker ID verkregen dmv OAuth protocol
verplicht

Response

Id
integer
FirstName
string
Voornaam
LastName
string
Achternaam
Insertions
string
Tussenvoegsel
BirthDate
date
Geboortedatum,
Notatie: yyyy-mm-dd
Gender
string
Geslacht

Mogelijke waarden: m manf vrouw

Street
string
Adres
HouseNr
integer
Huisnummer
HouseNrAddition
string
Toevoeging, zoals A
ZipCode
string
Postcode
City
string
Plaats
Country
string
Land
Phone
string
Telefoon
MobilePhone
string
Mobiele telefoon
Email
string
E-mail adres
Status
integer
Status van de consument

Mogelijke waarden: 1 enabled2 disabled3 deleted

Naar boven

passwordRecovery

1.1 Klanten

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

Parameters

Email
integer
E-mail adres van de consument.
verplicht

Response

Message
string
Bericht met de status van het verzenden.

Naar boven

setCustomer

1.1 Klanten

Slaat een klant op.

Parameters

id
integer
Indien een id wordt meegegeven wordt een bestaande consument aangepast, anders wordt een nieuwe consument aangemaakt.
AccountNumber
string
Klantnummer
Email
string
E-mail adres
verplicht
FirstName
string
Voornaam
verplicht
LastName
string
Achternaam
verplicht
Insertions
string
Tussenvoegsel
BirthDate
date
Geboortedatum

Notatie: yyyy-mm-dd

Gender
string
Geslacht M man, F vrouw
Street
string
Straat
HouseNr
integer
Huisnummer
HouseNrAddition
string
Toevoeging, bijv. A.
ZipCode
string
Postcode
City
string
Stad
Country
string
Land
Phone
string
Telefoonnummer. Indien dit veld niet leeg is, dient het een geldig telefoonnummer te bevatten.
MobilePhone
string
Mobiel telefoonnummer. Indien dit veld niet leeg is, dient het een geldig mobiel nummer te bevatten.
Status
integer
Status van de consument 1enabled 2disabled 3 deleted
[variabel]
string
Eventuele extra velden zoals verkregen met getFields. Gebruik de Key van een veld als naam voor de parameter
Username
string
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
string
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.

Response

Id
integer
Status
integer
Status van de consument

Mogelijke waarden: 1 enabled2 disabled3 deleted

Naar boven