OnlineAfspraken.nl API (1.1)

Download OpenAPI specification:Download

Volledige API-documentatie vanuit database

CHAddBlock

Voeg een beschikbaarheid blok toe. Let op: de voorkeur is om met roosters te werken. Het aanmaken van losse blokken kan administratief erg onduidelijk worden.

query Parameters

AgendaId required	integer Id van de agenda.
AppointmentType	integer Optioneel, id van een appointmentType.
ResourceId	integer Optioneel, id van een resource.
Date required	string Datum van het blok. Notatie: yyyy-mm-dd
StartTime required	string Starttijd van het blok. Notatie: hh:mm
EndTime required	string Eindtijd van het blok. Notatie: hh:mm

Responses

CHRemoveBlock

Verwijdert een blok dat eerder is aangemaakt met CHAddBlock

query Parameters

AgendaId required	integer Id van de agenda.
id required	integer Id van het block.

Responses

getCalculationModelSettings

Haalt de rekenmodel instellingen op van een afspraaktype. Deze plugins zijn in te schakelen via instellingen => extra functionaliteit. specificTimes: Specifieke tijden pluginmultiple: Meerdere personen plugintravel: Meerdere dagen pluginlimit:Beperking aantal afspraken plugincombination: Combinatieafspraken plugincomplex: Complexe afspraaktypen pluginconnectingApps: Aansluitende afspraken plugin

query Parameters

AgendaId required	integer Id van de agenda.
AppTypeId required	integer Id van het appointmentType.
CalculationModel required	string Naam van het rekenmodel. Geldige waarden zijn: specificTimes,multiple,limit,combination,complex,travel,connectingApps

Responses

setCalculationModelSettings

Slaat de rekenmodel instellingen op van een afspraaktype. Deze plugins zijn in te schakelen via instellingen => extra functionaliteit. specificTimes: Specifieke tijden pluginmultiple: Meerdere personen plugintravel: Meerdere dagen pluginlimit:Beperking aantal afspraken plugincombination: Combinatieafspraken plugincomplex: Complexe afspraaktypen pluginconnectingApps: Aansluitende afspraken plugin

query Parameters

AgendaId required	integer Id van de agenda.
AppTypeId required	integer Id van het appointmentType.
CalculationModel required	string Naam van het rekenmodel. Geldige waarden zijn: specificTimes,multiple,limit,combination,complex,travel,connectingApps
Value required	string JSON-encoded string met de configuratie van het rekenmodel
Enabled	integer Optioneel, 1 = aan, 0 = uit, schakelt het rekenmodel aan of uit

Responses

cancelAppointment

Annuleert een afspraak. N.B. om een afspraak definitief te verwijderen, gebruik je removeAppointment.

query Parameters

Id required	integer Id van de afspraak
Mode	string De manier waarop de afspraak geannuleerd wordt. 'customer' (standaardwaarde) annuleert op de manier waarop de klant het zou doen. Dit houdt bijvoorbeeld rekening met de maximale tijd voor annuleren. 'company' annuleert alsof het bedrijf het zou doen. Hierbij is meer vrijheid en zijn meer configuratiemogelijkheden.
Remarks	string Opmerkingen bij het annuleren (alleen als Mode='company')
Confirmations	integer Geeft aan of er een bevestiging naar de klant gestuurd wordt. Deze waarde heeft alleen invloed als Mode='company'; als Mode='customer' worden de instellingen van het systeem gevolgd. Mogelijke waarden: 0 = geen bevestigingen, 1 = bevestiging per e-mail,2 = bevestiging per sms,3 = bevestiging per mail en sms
DryRun	integer Als deze parameter wordt gebruikt met de waarde 1, worden alleen de voorwaarden gecontroleerd zonder de afspraak te annuleren. Dit kan nuttig zijn om te bepalen of de klant nog op tijd is voor het annuleren van de afspraak. Als de parameter niet wordt gebruikt, of de waarde 0 heeft, wordt de afspraak direct geannuleerd.

Responses

confirmAppointment

Confirms an appointment with a previously sent confirmation code. This code is sent to the customer by mail or SMS, depending on the backend configuration. If the code is valid the appointment status is changed from PENDING to CONFIRMED.

query Parameters

id required	integer Id if the appointment
ConfirmationCode required	integer Alphanumeric value that the consumer has received by mail or SMS.

Responses

getAppointment

Retrieves a specific appointment.

query Parameters

Id

required

integer

Id of the appointment

Responses

getAppointments

Retrieves all appointments for a specific calendar. Optionally a start and/or end date can be used to limit the query.

query Parameters

StartDate	string Start date. Notatie: yyyy-mm-dd
EndDate	string End date. Notatie: yyyy-mm-dd
UpdatedAfter	string If specified only the appointments that were modified after this time are returned.yyyy-mm-dd hh:mm:ss. Notatie: [tijd]
CreatedAfter	string If specified only the appointments that were created after this time are returned.yyyy-mm-dd hh:mm:ss. Notatie: [tijd]
CustomerId	integer If specified the query is filtered to this customer.
AppointmentTypeId	integer If specified the query is filtered to this appointmentType.
ResourceId	integer If specified the query is filtered to this resource.
AgendaId	integer Id of the calendar

Responses

removeAppointment

Deletes an appointment.

query Parameters

Id

required

integer

Id of the appointment.

Responses

setAppointment

Saves an appointment for a customer. If additional required fields are configured, to be retrieved by getFields API, these values are required for this API request.

query Parameters

AgendaId required	integer Id of the agenda.
CustomerId required	integer Id of the customer.
AppointmentTypeId required	integer Id of the appointmentType. This parameter is ignored when editing an existing appointment.
ResourceId	integer Id of the selected resource. If this parameter is not used the backend will autoselect an available resource. This parameter is ignored when editing an existing appointment.
Date required	string Date of the appointment. Notatie: yyyy-mm-dd
StartTime required	string Start time of the appointment. Notatie: hh:mm
EndTime required	string End time of the appointment. The end time can only be set when BookingMode=customer.. Notatie: hh:mm
Id	integer Optionally an appointment id can be supplied of a valid appointment. This will modify this appointment. If no Id is supplied, a new appointment is created.
Name	string Name
Description	string Note for the appointment. Note that when editing an existing appointment, the note will be added to the existing notes.
[variabel]	string Possible extra fields, as retrieved with the getFields API. Use the Key of a field as the parameter name in this request.
BookingMode	string Optional, consumer or customer. Default value is consumer. In consumer mode, an appointment can only be created or canceled. Modifying an existing appointment is only possible in customer mode.
OverrideMode	integer Optional, 1 = on, 0 = off. Disables multiple validations. Note that if the appointment is moved outside the bookable times then the appointment is not assigned a resource.
RequiredFieldsCheck	integer Optional, 1 = on, 0 = off, on by default. If 0, mandatory fields validations are disabled. Note that this can lead to unexpected results if there are assumptions regarding the status of a mandatory field.

Responses

getBookableBlocks

Haalt de boekbare blokken van een bepaald afspraaktype en voor een bepaalde resource zonder deze op te splitsen in boekbare tijden zoals in de widget getoond worden. Optioneel kan een start en/of einddatum opgegeven worden. Deze API past eventuele plugins etc niet toe op de beschikbaarheid. Gebruik bij voorkeur getBookableDates en getBookableTimes.

query Parameters

AgendaId required	integer Id van de agenda.
AppointmentTypeId, required	integer id van het appointmentType waar de beschikbaarheid van gecontroleerd wordt.
ResourceId	integer Id van de resource waar de beschikbaarheid van gecontroleerd wordt.
Date required	string Startdatum. Notatie: yyyy-mm-dd
EndDate	string Einddatum. Notatie: yyyy-mm-dd
ConsumerBookable	integer Indien 1 komen alleen blokken terug die door consumenten te boeken zijn.

Responses

getBookableDays

Retrieves the bookable days for a specific appoitnment type and resource. Optionally the query can be filtered with a start date and end date.

query Parameters

AgendaId required	integer Id of the agenda.
AppointmentTypeId required	integer Id of the appointmentType to get the availability for.
ResourceId	integer Id of the resource to get the availability for.
StartDate	string Start date. Notatie: yyyy-mm-dd
EndDate	string End date. Notatie: yyyy-mm-dd

Responses

getBookableTimes

Retrieves the bookable times for a specific appoitnment type and resource. Optionally the query can be filtered with a start date and end date.

query Parameters

AgendaId required	integer Id of the agenda.
Date required	date Date to get the available times for.
EndDate	date End date. If not specified, the times for a single day are returned
AppointmentTypeId required	integer Id of the appointmentType.
ResourceId	integer Id of the resource. If not supplied, bookable times for all resources are returned.

Responses

getCustomer

Retrieves a specific customer.

query Parameters

Id

required

integer

Id of the customer.

Responses

getCustomers

Retrieves all customers.

query Parameters

Limit	integer Query limit of customers to retrieve in one call.By default a maximum of 500 customers are returned.
Offset	integer Query offset of which customers to retrieve.
UpdatedAfter	date Only retrieve customers with an modify date after this value YYYY-MM-DD HH:mm:ss If this parameter is used also deleted customers are returned. These customers only retrieve Id and Status. If this parameter is not used, all customers are returned.
Email	string If used, only customers with this email address are returned.
BirthDate	date If used, only customers with this date of birth are returned. YYYY-MM-DD
AccountNumber	string If used, only customers with this account number are returned.

Responses

getFields

Retrieves the extra fields for registration and appointment forms.

query Parameters

AgendaId required	integer Id of the calendar.
AppointmentTypeId	integer If you specify the id of an appointmentType only fields that apply to that appointment type are returned.

Responses

loginCustomer

Login a customer with their credentials. If the login was valid a customer object is returned. Important: this API only validates credentials and thus can be used in your own custom widget implementation. This API does NOT log in a user and has no relation to the default bookingswidget. Please contact support for info about our SSO solution.

query Parameters

Username required	integer Username
Password required	integer Password

Responses

passwordRecovery

Sends an email to reset the password to a customer.

query Parameters

Email

required

string

Email address of the customer.

Responses

setCustomer

Stores a customer.

query Parameters

id	integer If an id is supplied, an existing customer is modified. If not, a new customer is created.
AccountNumber	string Account number
Email required	string Email address
FirstName required	string First name
LastName required	string Last name
Insertions	string Name insertions
BirthDate	date Date of birthyyyy-mm-dd
Gender	string GenderM male, F female
Street	string Street
HouseNr	integer House number
HouseNrAddition	string House number addition
ZipCode	string Zipcode
City	string City
Country	string Country
Phone	string Phone number. If this field is not empty it has to be valid.
MobilePhone	string Mobile phone number. If this field is not empty it has to be valid.
Status	integer Status of the customer 1enabled 2disabled 3 deleted
[variabel]	string Possible extra field as retrieved by getFields. Use the Key of the field as the name of the paraneter.
Username	string Username of the account that the customer can use to login to their account. User account can only be created for new customers. For existing customers this parameter is ignored. If you don't want to create a user account leave this parameter empty.
Password	string The password of the user account. The password has to be at least 6 characters long. This parameter is required if you use the Username parameter to create a new user account. For existing customers this parameter is ignored.

Responses

getAgenda

Retrieves the calendar for the company.

query Parameters

Id	integer Id of the calendar

Responses

getAgendas

Retrieves all calendars of a company.

Responses

getAppointmentType

Retrieves a specific appointment type.

query Parameters

Id

required

integer

Id of the appointment type

Responses

getAppointmentTypes

Retrieves all appointment types.

Responses

getResource

Retrieves a specific resource.

query Parameters

Id

required

integer

Id of the resource

Responses

getResources

Retrieves all resources.

Responses

requiresConfirmation

Determines whether a confirmation code is required to book the appointment. When true, the appointment booking with the setAppointment API remains in PENDING status until confirmation is completed. This is a global setting. You should retrieve this value once, and not for every appointment.