Zum Hauptinhalt springen
GET
Gibt die buchbaren Slot-Startzeiten für einen einzelnen Standort im angefragten Zeitraum zurück. Slots werden aus den open_hours des Standorts erzeugt, wobei globale und standortspezifische Sperrtage übersprungen und bereits gebuchte Aniva-Termine abgezogen werden, sodass das Ergebnis widerspiegelt, was deine Patienten clientseitig tatsächlich reservieren können. Erfordert den Scope appointments_schedule. Der Standort muss außerdem im Standortgruppen-Zugriffskontext deines API-Schlüssels liegen.
Nutze diesen Endpunkt, statt die Verfügbarkeit aus den statischen open_hours von Standorte auflisten abzuleiten – nur dieser Endpunkt berücksichtigt Live-Buchungen, tagesbezogene Ausnahmen im Zeitplan und die 12-stündige Mindestvorlaufzeit an von Aniva betriebenen Standorten. Jeder hier zurückgegebene Slot ist direkt so buchbar.
Antworten enthalten Cache-Control: private, max-age=30, stale-while-revalidate=60, sodass ein Browser eine zwischengespeicherte Antwort bis zu ca. 30 Sekunden lang ausliefern kann – ein in diesem Zeitfenster gebuchter Slot kann bis zur nächsten Aktualisierung noch als buchbar erscheinen. Zeige Konflikte auch bei der Buchung an.

Pfadparameter

string
erforderlich
Standortkennung (UUID). Verwende die id aus Standorte auflisten.

Query-Parameter

string
Inklusiver Beginn des Zeitraums im Format YYYY-MM-DD (interpretiert in timezone). Optional. Standardmäßig heute, wenn kein Datum angegeben wird, oder end_date − 30 days, wenn nur end_date angegeben wird. Daten in der Vergangenheit werden stillschweigend auf heute begrenzt.
string
Inklusives Ende des Zeitraums im Format YYYY-MM-DD (interpretiert in timezone). Optional. Standardmäßig heute + 30 Tage, wenn kein Datum angegeben wird, oder start_date + 30 days, wenn nur start_date angegeben wird. Muss am oder nach start_date und innerhalb von 90 Tagen ab heute liegen.
string
IANA-Zeitzone (z. B. Europe/Berlin), die zur Interpretation von start_date / end_date und zur Gruppierung von Slots nach Kalendertag dient. Optional – standardmäßig die Zeitzone des Standorts. Die Slot-Startzeiten selbst werden immer als UTC-Zeitpunkte (Z) ausgegeben und verschieben sich mit diesem Parameter nicht – das Slot-Raster richtet sich immer nach der Zeitzone des Standorts; der Parameter beeinflusst nur, welchem Kalendertag ein Slot zugeordnet wird. Die Tageseinträge in der Antwort decken genau start_date..end_date als Kalendertage in dieser Zeitzone ab. Lass ihn weg, sofern du die Auswahl nicht in einer anderen Zeitzone anzeigst.

Antwort

Bei Erfolg gibt die API 200 OK mit einem einzelnen Verfügbarkeitsobjekt zurück.
string
erforderlich
Übernommene Standortkennung.
string
erforderlich
IANA-Zeitzone, in der die Antwort ausgegeben wird (z. B. Europe/Berlin) – übernimmt den Query-Parameter timezone, falls angegeben, sonst die Zeitzone des Standorts.
integer
Abstand zwischen aufeinanderfolgenden buchbaren Slot-Startzeiten in Minuten. Der für den Standort konfigurierte Rasterschritt – jeder Slot in availability liegt auf diesem Raster. Nur null, wenn der Standort keine Terminplanungs-Konfiguration hat. Kein Zeitfenster für die Termindauer: Überschneidende Buchungen mit unterschiedlichen Startzeiten stehen nicht im Konflikt; nur exakte Startzeit-Kollisionen zählen für die Parallelität.
array
erforderlich
Buchbare Slots pro Tag. Tage ohne buchbare Slots werden ausgelassen, um die Antwort kompakt zu halten. Jeder Eintrag enthält:

Fehlerantworten