Saltar al contingut principal
GET
Retorna les hores d’inici de les franges reservables d’una sola ubicació dins l’interval sol·licitat. Les franges es generen a partir de open_hours de la ubicació, ometent les dates bloquejades globals / per ubicació i restant les cites d’Aniva ja reservades, de manera que el resultat reflecteix el que els teus pacients poden reservar realment des del client. Requereix l’àmbit appointments_schedule. La ubicació també ha d’estar inclosa dins el context d’accés de grups d’ubicacions de la teva clau d’API.
Fes servir aquest punt final en lloc de deduir la disponibilitat a partir dels valors estàtics de open_hours que retorna Llista les ubicacions — només aquest punt final té en compte les reserves en temps real, les excepcions d’horari per data i el preavís mínim de 12 hores a les ubicacions gestionades per Aniva. Cada franja retornada aquí es pot reservar tal qual.
Les respostes inclouen Cache-Control: private, max-age=30, stale-while-revalidate=60, de manera que un navegador pot servir una càrrega útil en memòria cau durant fins a ~30 segons — una franja reservada dins aquest interval encara pot aparèixer com a reservable fins a la pròxima actualització. Mostra també els conflictes en el moment de fer la reserva.

Paràmetres de ruta

string
requerit
Identificador de la ubicació (UUID). Fes servir l’id de Llista les ubicacions.

Paràmetres de consulta

string
Inici inclusiu de l’interval en format YYYY-MM-DD (interpretat en timezone). Opcional. Per defecte és avui si no s’indica cap data, o end_date − 30 days si només s’indica end_date. Les dates passades s’ajusten silenciosament a avui.
string
Final inclusiu de l’interval en format YYYY-MM-DD (interpretat en timezone). Opcional. Per defecte és avui + 30 dies si no s’indica cap data, o start_date + 30 days si només s’indica start_date. Ha de ser igual o posterior a start_date i dins els 90 dies següents a avui.
string
Zona horària IANA (p. ex., Europe/Berlin) utilitzada per interpretar start_date / end_date i per agrupar les franges per data del calendari. Opcional — per defecte fa servir la zona horària pròpia de la ubicació. Les hores d’inici de les franges sempre es mostren com a instants UTC (Z) i no canvien mai amb aquest paràmetre — la graella de franges sempre es projecta des de la zona horària de la ubicació; el paràmetre només afecta en quin dia del calendari s’agrupa una franja. Les entrades de dia de la resposta cobreixen exactament start_date..end_date com a dies del calendari en aquesta zona horària. Omet-lo tret que mostris el selector en una altra zona horària.

Resposta

En cas d’èxit, l’API retorna 200 OK amb un únic objecte de disponibilitat.
string
requerit
Identificador de la ubicació reproduït.
string
requerit
Zona horària IANA en què es mostra la resposta (p. ex., Europe/Berlin) — reprodueix el paràmetre de consulta timezone quan s’indica; en cas contrari, la zona horària pròpia de la ubicació.
integer
Separació en minuts entre els inicis consecutius de franges reservables. És el pas de la graella configurat a la ubicació — cada franja d’availability cau en aquesta graella. Només és null quan la ubicació no té configuració d’horaris. No és un interval de durada de la cita: les reserves superposades amb hores d’inici diferents no entren en conflicte; només les coincidències d’inici exacte compten per a la concurrència.
array
requerit
Franges reservables per dia. Els dies sense franges reservables s’ometen per mantenir la càrrega útil compacta. Cada entrada té:

Respostes d’error