Przejdź do głównej treści
GET
Zwraca dostępne godziny rozpoczęcia terminów dla jednej lokalizacji w podanym przedziale. Terminy są generowane na podstawie open_hours lokalizacji, z pominięciem globalnych i lokalnych zablokowanych dat oraz po odjęciu już zarezerwowanych wizyt Aniva, dzięki czemu wynik odzwierciedla to, co twoi pacjenci faktycznie mogą zarezerwować po stronie klienta. Wymaga zakresu appointments_schedule. Lokalizacja musi też mieścić się w kontekście dostępu grupy lokalizacji twojego klucza API.
Używaj tego endpointu zamiast wnioskować o dostępności ze statycznego pola open_hours zwracanego przez Lista lokalizacji — tylko ten endpoint uwzględnia bieżące rezerwacje, wyjątki w harmonogramie dla konkretnych dat oraz 12-godzinne minimalne wyprzedzenie w lokalizacjach prowadzonych przez Aniva. Każdy zwrócony tutaj termin można od razu zarezerwować.
Odpowiedzi zawierają nagłówek Cache-Control: private, max-age=30, stale-while-revalidate=60, więc przeglądarka może serwować dane z pamięci podręcznej przez maksymalnie ok. 30 sekund — termin zarezerwowany w tym oknie może nadal wyglądać na dostępny do następnego odświeżenia. Wyświetlaj konflikty również w momencie rezerwacji.

Parametry ścieżki

string
wymagane
Identyfikator lokalizacji (UUID). Użyj id z Lista lokalizacji.

Parametry zapytania

string
Początek przedziału (włącznie) w formacie YYYY-MM-DD (interpretowany w timezone). Opcjonalne. Domyślnie dzisiaj, gdy nie podano żadnej daty, albo end_date − 30 days, gdy podano tylko end_date. Daty z przeszłości są automatycznie przycinane do dzisiejszej daty.
string
Koniec przedziału (włącznie) w formacie YYYY-MM-DD (interpretowany w timezone). Opcjonalne. Domyślnie dzisiaj + 30 dni, gdy nie podano żadnej daty, albo start_date + 30 days, gdy podano tylko start_date. Musi przypadać nie wcześniej niż start_date i w ciągu 90 dni od dzisiaj.
string
Strefa czasowa IANA (np. Europe/Berlin) używana do interpretacji start_date / end_date oraz grupowania terminów według daty kalendarzowej. Opcjonalne — domyślnie używana jest strefa czasowa samej lokalizacji. Same godziny rozpoczęcia terminów są zawsze zwracane jako znaczniki UTC (Z) i nigdy nie przesuwają się pod wpływem tego parametru — siatka terminów jest zawsze wyznaczana w strefie czasowej lokalizacji; parametr wpływa wyłącznie na to, do którego dnia kalendarzowego zostanie przypisany termin. Wpisy dzienne w odpowiedzi obejmują dokładnie start_date..end_date jako dni kalendarzowe w tej strefie czasowej. Pomiń ten parametr, chyba że wyświetlasz wybór terminu w innej strefie czasowej.

Odpowiedź

W przypadku powodzenia API zwraca 200 OK z pojedynczym obiektem dostępności.
string
wymagane
Zwrócony identyfikator lokalizacji.
string
wymagane
Strefa czasowa IANA, w której zwracana jest odpowiedź (np. Europe/Berlin) — powtarza parametr zapytania timezone, jeśli go podano, a w przeciwnym razie strefę czasową samej lokalizacji.
integer
Odstęp w minutach między kolejnymi dostępnymi godzinami rozpoczęcia terminów. Krok siatki skonfigurowany dla lokalizacji — każdy termin w availability wypada na tej siatce. null tylko wtedy, gdy lokalizacja nie ma konfiguracji harmonogramu. Nie jest to czas trwania wizyty: nakładające się rezerwacje o różnych godzinach rozpoczęcia nie kolidują ze sobą; do limitu równoczesnych wizyt liczą się tylko kolizje tej samej godziny rozpoczęcia.
array
wymagane
Dostępne terminy w podziale na dni. Dni bez dostępnych terminów są pomijane, aby ograniczyć rozmiar odpowiedzi. Każdy wpis zawiera:

Odpowiedzi z błędami