User API guide/nl: Difference between revisions

Created page with "'''Codevoorbeeld voor het ophalen van de lijst met services''' <br><br> <nowiki>$services = $client->getEventList(); // retourneert array(array( // 'id' => 1, - service-id // 'name' => 'Service 1', - naam van de service // 'description' => 'Beschrijf uw service...', - beschrijving van de service // 'duration' => 60, - duur van de service // 'hide_duration' => 0, - vlag om duur voor klanten te verbergen, // 'picture' => null,..."
Tags: Mobile edit Mobile web edit
Created page with "= '''GEGEVENS OPVRAGEN VAN DE SIMPLYBOOK-SERVER''' = <br><br> Een boekingspagina is meestal een pagina waar klanten de gewenste dienst, een medewerker en een tijdstip voor hun afspraak kiezen. Vervolgens vult de klant enkele contactgegevens in en bevestigt hij de boeking. Complexere oplossingen kunnen het invullen van verschillende intakeformulieren, het maken van groeps- of meervoudige boekingen enzovoort omvatten. Laten we de workflow voor het maken van de eenvoudigste..."
Line 129: Line 129:
<br><br>
<br><br>


<div lang="en" dir="ltr" class="mw-content-ltr">
'''Codevoorbeeld voor het ophalen van een lijst met dienstverleners'''
'''Code example of getting service performers list'''
<br><br>
<br><br>
  <nowiki>$services = $client->getUnitList();
  <nowiki>$services = $client-&gt;getUnitList();
// returns array(array(
// retourneert array(array(
//    'id' => 1, - performer id
//    'id' =&gt; 1, - id van de dienstverlener
//    'name' => 'Provider 1', - performer name
//    'name' =&gt; 'Provider 1', - naam van de uitvoerder
//    'phone' => '111111111', - perfomer phone number
//    'phone' =&gt; '111111111', - telefoonnummer van de uitvoerder
//    'description' => 'Describe your performer...', - performer description
//    'description' =&gt; 'Beschrijf uw uitvoerder...', - beschrijving van de uitvoerder
//    'email' => 'test@gmail.com', - perfomer email,
//    'email' =&gt; 'test@gmail.com', - e-mailadres van de uitvoerder,
//    'is_active' => 1, - the performer is activated
//    'is_active' =&gt; 1, - de uitvoerder is geactiveerd
//    'is_visible' => 1, - the perfomer is visible for clients,
//    'is_visible' =&gt; 1, - de artiest is zichtbaar voor klanten,
//    'picture' => null, - file name of picture or null,
//    'picture' =&gt; null, - bestandsnaam van foto of null,
//    'picure_path' => '/uploads/apidemo/unit_group__picture/small/', - full path to picture
//    'picure_path' =&gt; '/uploads/apidemo/unit_group__picture/small/', - volledig pad naar foto
//    'position' => 1, - performer position
//    'position' =&gt; 1, - positie van artiest
//    'qty' => 1, performer quantity
//    'qty' =&gt; 1, aantal artiesten
// ), ...)</nowiki>
// ), ...)</nowiki>
<br><br>
<br><br>
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
De volgende stap voor een klant is het kiezen van een datum en tijdstip voor zijn dienst. We hebben een Bootstrap-datumkiezer gebruikt in het API-gebruikvoorbeeld, maar u kunt ook deze of een andere kalender gebruiken. Om de eerste datum van uw kalender in te stellen, gebruikt u de methode getFirstWorkingDay. Deze methode kan het werknemers-id als parameter gebruiken en geeft de volgende datum terug waarop de geselecteerde werknemer (of standaard alle werknemers in het bedrijf) beschikbaar is voor boeking. Om tijdvakken binnen een geselecteerde datum weer te geven, hebt u de methoden getWorkCalendar en getStartTimeMatrix nodig. De eerste methode geeft u informatie over de begin- en eindtijd van de werkdag en over vrije dagen. De tweede methode retourneert de lijst met tijdvakken die voor een bepaalde datum kunnen worden geboekt.
The next step to a client is to pick a date and time of his service. We've used a Bootstrap date-picker in API-usage example, you can also use this or any other calendar. To set your calendar first date use getFirstWorkingDay method. It can take employee id as a parameter and returns the next date when the selected employee (or any employee in the company by default) is avaiable for booking. To show time slots inside a selected date you need getWorkCalendar and getStartTimeMatrix methods. The first method give you an information about working day start and end time, and about day-offs. And the second one returns the list of time-slots which can be booked for a certain date.
<br><br>
<br><br>
'''Code example of getting work days info'''
'''Codevoorbeeld voor het ophalen van informatie over werkdagen'''
<br><br>
<br><br>
</div>


  <div lang="en" dir="ltr" class="mw-content-ltr">
  <nowiki>$jaar = 2015;
<nowiki>$year = 2015;
$maand = 3; // maart
$month = 3; // March
$artiestId = 1; // kan null zijn
$performerId = 1; // Can be null  
$werkdagenInfo = $client-&gt;getWorkCalendar($jaar, $maand, $artiestId);
$workDaysInfo = $client->getWorkCalendar($year, $month, $performerId);
// retourneert array(
// returns array(
//    '2015-03-01' =&gt; array('van' =&gt; '09:00:00', 'to' =&gt; '18:00:00', 'is_day_off' =&gt; 0),
//    '2015-03-01' => array('from' => '09:00:00', 'to' => '18:00:00', 'is_day_off' => 0),
//    '2015-03-02' =&gt; array('from' =&gt; '09:00:00', 'to' =&gt; '18:00:00', 'is_day_off' =&gt; 0),
//    '2015-03-02' => array('from' => '09:00:00', 'to' => '18:00:00', 'is_day_off' => 0),
//    ...
//    ...
//);</nowiki>
//);</nowiki>
<br><br>
<br><br>
'''Code example of getting start time matrix'''
'''Codevoorbeeld voor het ophalen van de starttijdmatrix'''
<br><br>
<br><br>
  <nowiki>$dateFrom = '2015-03-03';
  <nowiki>$dateFrom = '2015-03-03';
Line 174: Line 169:
$performerId = 1;
$performerId = 1;
$qty = 1;
$qty = 1;
$availableTime = $client->getStartTimeMatrix($dateFrom, $dateTo, $serviceId, $performerId, $qty);
$availableTime = $client-&gt;getStartTimeMatrix($dateFrom, $dateTo, $serviceId, $performerId, $qty);
// returns array(
// retourneert array(
//    '2015-03-03' => array('09:00:00', '09:30:00', '10:00:00', ....),
//    '2015-03-03' =&gt; array('09:00:00', '09:30:00', '10:00:00', ....),
//    '2015-03-04' => array('09:00:00', '09:30:00', '10:00:00', ....),
//    '2015-03-04' =&gt; array('09:00:00', '09:30:00', '10:00:00', ....),
//);</nowiki>
//);</nowiki>
<br><br>
<br><br>
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
Een andere handige methode die u wellicht nodig hebt, is calculateEndTime. Elke dienst kan een eigen duur hebben, en ook de werknemers van uw bedrijf kunnen van dag tot dag verschillende werktijden hebben. Met deze methode kunt u een klant op de juiste manier de einddatum en -tijd van de door hem geboekte dienst tonen.
Another usefull method you may need is calculateEndTime. Each service can have its own duration, also your company's employees possible have different work schedule form day to day. So using this method you can show to a client an end date and time of the service he've booked in a correct way.
<br><br>
<br><br>
'''Code example of calculating booking end time'''
'''Codevoorbeeld voor het berekenen van de eindtijd van een boeking'''
<br><br>
<br><br>
  <nowiki>$startDateTime = '2015-03-03 09:00:00';
  <nowiki>$startDateTime = '2015-03-03 09:00:00';
$serviceId = 1;
$serviceId = 1;
$performerId = 1;
$performerId = 1;
$availableTime = $client->calculateEndTime($startDateTime, $serviceId, $performerId);
$availableTime = $client-&gt;calculateEndTime($startDateTime, $serviceId, $performerId);
// returns '2015-03-03 10:00:00'
// retourneert '2015-03-03 10:00:00'
</nowiki>
</nowiki>
<br><br>
<br><br>
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<div lang="en" dir="ltr" class="mw-content-ltr">