Vai al contenuto principale
GET
Restituisce gli orari di inizio degli slot prenotabili per una singola sede nell’intervallo richiesto. Gli slot vengono generati a partire da open_hours della sede, saltando le date bloccate globali / per sede e sottraendo gli appuntamenti Aniva già prenotati, così il risultato rispecchia ciò che i tuoi pazienti possono effettivamente prenotare lato client. Richiede lo scope appointments_schedule. La sede deve inoltre rientrare nel contesto di accesso ai gruppi di sedi della tua chiave API.
Usa questo endpoint invece di dedurre la disponibilità dagli orari statici open_hours restituiti da Elenca sedi — solo questo endpoint tiene conto delle prenotazioni in tempo reale, delle eccezioni di orario per singola data e del preavviso minimo di 12 ore presso le sedi gestite da Aniva. Ogni slot restituito qui è prenotabile così com’è.
Le risposte includono Cache-Control: private, max-age=30, stale-while-revalidate=60, quindi un browser può servire un payload in cache fino a ~30 secondi — uno slot prenotato in quella finestra può risultare ancora prenotabile fino al successivo aggiornamento. Mostra eventuali conflitti anche al momento della prenotazione.

Parametri di percorso

string
obbligatorio
Identificativo della sede (UUID). Usa l’id di Elenca sedi.

Parametri di query

string
Inizio inclusivo dell’intervallo in formato YYYY-MM-DD (interpretato in timezone). Facoltativo. Il valore predefinito è oggi quando non viene fornita nessuna data, oppure end_date − 30 days quando viene fornita solo end_date. Le date passate vengono automaticamente riportate a oggi.
string
Fine inclusiva dell’intervallo in formato YYYY-MM-DD (interpretata in timezone). Facoltativo. Il valore predefinito è oggi + 30 giorni quando non viene fornita nessuna data, oppure start_date + 30 days quando viene fornita solo start_date. Deve essere uguale o successiva a start_date ed entro 90 giorni da oggi.
string
Fuso orario IANA (es. Europe/Berlin) usato per interpretare start_date / end_date e per raggruppare gli slot per data di calendario. Facoltativo — il valore predefinito è il fuso orario della sede. Gli orari di inizio degli slot vengono sempre restituiti come istanti UTC (Z) e non cambiano con questo parametro — la griglia degli slot è sempre calcolata nel fuso orario della sede; il parametro influisce solo sul giorno di calendario in cui viene raggruppato uno slot. Le voci giornaliere nella risposta coprono esattamente start_date..end_date come giorni di calendario in questo fuso orario. Omettilo a meno che tu non mostri il selettore in un altro fuso orario.

Risposta

In caso di successo, l’API restituisce 200 OK con un singolo oggetto disponibilità.
string
obbligatorio
Identificativo della sede ripetuto dalla richiesta.
string
obbligatorio
Fuso orario IANA usato nella risposta (es. Europe/Berlin) — ripete il parametro query timezone se fornito, altrimenti il fuso orario della sede.
integer
Intervallo in minuti tra gli orari di inizio di slot prenotabili consecutivi. È il passo della griglia configurato per la sede — ogni slot in availability cade su questa griglia. È null solo quando la sede non ha una configurazione di pianificazione. Non indica la durata dell’appuntamento: le prenotazioni sovrapposte con orari di inizio diversi non vanno in conflitto; solo le collisioni sullo stesso identico orario di inizio contano ai fini della concorrenza.
array
obbligatorio
Slot prenotabili per giorno. I giorni senza slot prenotabili vengono omessi per mantenere il payload leggero. Ogni voce contiene:

Risposte di errore