/externalBooking/calcAvailableAppointments2
Diese Schnittstelle liefert genau dasselbe Ergebnis wie Verfügbare Termine (calcAvailableAppointments): alle verfügbaren Uhrzeiten für den angegebenen Zeitraum. Der einzige Unterschied liegt in der Übergabe der Daten.
calcAvailableAppointments erwartet die Felder als Formulardaten (application/x-www-form-urlencoded), Listen und Zuordnungen also in der Schreibweise bookingGroups[0]. calcAvailableAppointments2 erwartet stattdessen einen JSON-Body mit Content-Type: application/json. Verschachtelte Werte wie selectedProducts und bookingGroups stehen damit als echte JSON-Liste beziehungsweise als JSON-Objekt im Body und müssen nicht mehr in Feldnamen kodiert werden.
Welche der beiden Varianten Sie verwenden, ist Ihnen überlassen: Antwortformat, Rechte und Verhalten sind identisch. Für neue Anbindungen empfiehlt sich calcAvailableAppointments2, weil der Body derselben Schreibweise folgt wie bei Buchung starten und die Felder dadurch unverändert weitergereicht werden können.
Header
| Name | Wert |
|---|---|
Content-Type |
application/json |
Request-Body (JSON)
Pflichtfelder
| Feld | Typ |
|---|---|
servicerGroupId |
Zahl |
Beispiel16
ID des Standorts, für den die freien Uhrzeiten berechnet werden.
|
|
selectedProducts |
Liste |
Beispiel[180612]
IDs der gewünschten Leistungen als Liste, aus der Leistungsabfrage (calcGroups).
|
|
numberOfDays |
Zahl |
Beispiel1
Anzahl der Tage ab "offset", für die verfügbare Uhrzeiten berechnet werden.
|
|
bookingGroups |
Objekt |
Beispiel{"0":-1}
Ordnet jeder gewünschten Position einen Mitarbeiter zu.
|
|
bookingGroups.0 |
Zahl |
Beispiel-1
Mitarbeiter-ID für die erste Position; -1 steht für "beliebiger Mitarbeiter".
|
|
offset |
Text |
Beispiel02.01.2019
Erster Tag des abgefragten Zeitraums im Format TT.MM.JJJJ. Die Antwort ist nach genau diesen Tagesdaten gegliedert.
|
|
Optionale Felder
| Feld | Typ |
|---|---|
bookingSource |
Text |
BeispielYour API
Freier Text, der die Herkunft der Anfrage kennzeichnet – zum Beispiel der Name Ihrer Anwendung. Sinnvollerweise derselbe Wert, der später bei der eigentlichen Buchung mitgeschickt wird.
|
|
Vollständiger Beispiel-Body
{
"servicerGroupId": 16,
"selectedProducts": [
180612
],
"numberOfDays": 1,
"bookingGroups": {
"0": -1
},
"offset": "02.01.2019",
"bookingSource": "Your API"
}