Ugrás a fő tartalomhoz
GET
Visszaadja egy adott helyszín foglalható idősávjainak kezdési időpontjait a kért időablakban. Az idősávokat a helyszín open_hours adatai alapján generáljuk, kihagyva a globális és helyszínszintű zárolt dátumokat, valamint levonva a már lefoglalt Aniva-időpontokat, így az eredmény pontosan azt mutatja, amit a pácienseid kliensoldalon valóban le tudnak foglalni. Az appointments_schedule scope szükséges hozzá. A helyszínnek az API-kulcsod helyszíncsoport-hozzáférési körébe is bele kell esnie.
Ahelyett, hogy a Helyszínek listázása végpont által visszaadott statikus open_hours adatokból következtetnél az elérhetőségre, használd ezt a végpontot – csak ez veszi figyelembe az élő foglalásokat, a dátumonkénti nyitvatartási kivételeket, valamint az Aniva által üzemeltetett helyszíneken érvényes 12 órás minimális előzetes értesítési időt. Minden itt visszaadott idősáv közvetlenül foglalható.
A válaszok Cache-Control: private, max-age=30, stale-while-revalidate=60 fejlécet tartalmaznak, így a böngésző akár ~30 másodpercig gyorsítótárazott választ is kiszolgálhat – egy ezen az ablakon belül lefoglalt idősáv a következő frissítésig még foglalhatónak tűnhet. A foglaláskor fellépő ütközéseket is jelenítsd meg.

Útvonalparaméterek

string
kötelező
Helyszínazonosító (UUID). Használd a Helyszínek listázása végpontból kapott id értéket.

Lekérdezési paraméterek

string
Az időablak kezdő dátuma (beleértve) YYYY-MM-DD formátumban (a timezone alapján értelmezve). Opcionális. Alapértelmezett értéke a mai nap, ha egyik dátum sincs megadva, vagy end_date − 30 days, ha csak az end_date van megadva. A múltbeli dátumokat a rendszer csendben a mai napra korlátozza.
string
Az időablak záró dátuma (beleértve) YYYY-MM-DD formátumban (a timezone alapján értelmezve). Opcionális. Alapértelmezett értéke ma + 30 nap, ha egyik dátum sincs megadva, vagy start_date + 30 days, ha csak a start_date van megadva. A start_date dátummal megegyező vagy annál későbbi, és a mai naptól számított 90 napon belüli dátumnak kell lennie.
string
IANA időzóna (pl. Europe/Berlin), amely a start_date / end_date értelmezésére és az idősávok naptári nap szerinti csoportosítására szolgál. Opcionális – alapértelmezetten a helyszín saját időzónája. Maguk az idősávok kezdési időpontjai mindig UTC időpontként (Z) jelennek meg, és nem változnak ezzel a paraméterrel – az idősávrács mindig a helyszín saját időzónájából származik; a paraméter csak azt befolyásolja, hogy egy idősáv melyik naptári nap alá kerül. A válaszban szereplő napi bejegyzések pontosan a start_date..end_date tartományt fedik le naptári napként ebben az időzónában. Hagyd el, hacsak nem másik időzónában jeleníted meg az időpontválasztót.

Válasz

Sikeres kérés esetén az API 200 OK választ ad vissza egyetlen elérhetőségi objektummal.
string
kötelező
A visszaküldött helyszínazonosító.
string
kötelező
Az IANA időzóna, amelyben a válasz megjelenik (pl. Europe/Berlin) – ha megadtad a timezone lekérdezési paramétert, azt adja vissza, egyébként a helyszín saját időzónáját.
integer
Az egymást követő foglalható idősávok kezdete közötti távolság percben. A helyszínnél beállított rácslépésköz – az availability minden idősávja erre a rácsra esik. Csak akkor null, ha a helyszínhez nincs időpont-beosztási beállítás. Nem az időpont időtartamát jelöli: a különböző kezdési idejű, egymást átfedő foglalások nem ütköznek; csak a pontosan azonos kezdésű ütközések számítanak az egyidejűségbe.
array
kötelező
Napi bontású foglalható idősávok. Azokat a napokat, amelyeken nincs foglalható idősáv, kihagyjuk, hogy a válasz tömör maradjon. Minden bejegyzés a következőket tartalmazza:

Hibaválaszok