Přejít na hlavní obsah
GET
Vrátí začátky volných slotů k rezervaci pro jednu lokalitu v požadovaném období. Sloty se generují z open_hours dané lokality, přičemž se vynechají globálně nebo lokálně blokovaná data a odečtou už rezervované termíny Aniva, takže výsledek odpovídá tomu, co si tvoji pacienti mohou na straně klienta skutečně rezervovat. Vyžaduje scope appointments_schedule. Lokalita navíc musí spadat do přístupového kontextu skupiny lokalit tvého API klíče.
Používej tento endpoint místo odvozování dostupnosti ze statického pole open_hours, které vrací Seznam lokalit – jen tento endpoint zohledňuje aktuální rezervace, výjimky v rozvrhu pro konkrétní dny a 12hodinový minimální předstih v lokalitách provozovaných Aniva. Každý slot vrácený tímto endpointem lze rovnou rezervovat.
Odpovědi obsahují Cache-Control: private, max-age=30, stale-while-revalidate=60, takže prohlížeč může vracet data z mezipaměti až zhruba 30 sekund – slot rezervovaný v tomto okně se tak až do dalšího načtení může dál tvářit jako volný. Konflikty zobrazuj i při samotné rezervaci.

Parametry cesty

string
povinné
Identifikátor lokality (UUID). Použij id ze Seznamu lokalit.

Parametry dotazu

string
Začátek období včetně ve formátu YYYY-MM-DD (vyhodnocovaný v timezone). Nepovinný. Výchozí hodnota je dnešek, pokud neuvedeš ani jedno datum, nebo end_date − 30 days, pokud uvedeš jen end_date. Data v minulosti se bez upozornění posunou na dnešek.
string
Konec období včetně ve formátu YYYY-MM-DD (vyhodnocovaný v timezone). Nepovinný. Výchozí hodnota je dnešek + 30 dní, pokud neuvedeš ani jedno datum, nebo start_date + 30 days, pokud uvedeš jen start_date. Musí být rovné nebo pozdější než start_date a nejvýše 90 dní od dneška.
string
Časové pásmo IANA (např. Europe/Berlin), ve kterém se vyhodnocují start_date / end_date a seskupují sloty podle kalendářního data. Nepovinný – výchozí je vlastní časové pásmo lokality. Samotné časy začátků slotů se vždy vrací v UTC (Z) a tímto parametrem se neposouvají – mřížka slotů vždy vychází z vlastního časového pásma lokality; parametr ovlivňuje jen to, pod jaký kalendářní den se slot zařadí. Položky dnů v odpovědi pokrývají přesně kalendářní dny start_date..end_date v tomto časovém pásmu. Pokud nezobrazuješ výběr termínu v jiném časovém pásmu, parametr vynech.

Odpověď

Při úspěchu API vrátí 200 OK s jedním objektem dostupnosti.
string
povinné
Zopakovaný identifikátor lokality.
string
povinné
Časové pásmo IANA, ve kterém je odpověď vrácena (např. Europe/Berlin) – opakuje parametr dotazu timezone, pokud byl uveden, jinak vlastní časové pásmo lokality.
integer
Rozestup mezi začátky po sobě jdoucích rezervovatelných slotů v minutách. Krok mřížky nastavený pro lokalitu – každý slot v availability spadá do této mřížky. null jen v případě, že lokalita nemá nastavený rozvrh. Nejde o délku termínu: překrývající se rezervace s různým začátkem nekolidují; do souběžnosti se počítají jen přesné shody začátků.
array
povinné
Rezervovatelné sloty po jednotlivých dnech. Dny bez volných slotů se vynechávají, aby byla odpověď co nejmenší. Každá položka obsahuje:

Chybové odpovědi