Hoppa till huvudinnehåll
GET
Returnerar bokningsbara starttider för en enskild plats inom det begärda tidsfönstret. Tiderna genereras från platsens open_hours, där globala och platsspecifika spärrade datum hoppas över och redan bokade Aniva-bokningar räknas bort, så att resultatet motsvarar vad dina patienter faktiskt kan boka på klientsidan. Kräver scopet appointments_schedule. Platsen måste också ingå i din API-nyckels åtkomstkontext för platsgrupper.
Använd den här endpointen i stället för att härleda tillgänglighet från statiska open_hours som returneras av Lista platser — bara den här endpointen tar hänsyn till aktuella bokningar, datumspecifika schemaundantag och 12-timmarsgränsen för minsta framförhållning på platser som drivs av Aniva. Varje tid som returneras här går att boka direkt.
Svar har Cache-Control: private, max-age=30, stale-while-revalidate=60, så en webbläsare kan visa ett cachat svar i upp till ca 30 sekunder — en tid som bokas inom det fönstret kan fortfarande visas som bokningsbar fram till nästa uppdatering. Hantera konflikter även vid bokningstillfället.

Sökvägsparametrar

string
obligatorisk
Platsidentifierare (UUID). Använd id från Lista platser.

Frågeparametrar

string
Inkluderande startdatum för fönstret i formatet YYYY-MM-DD (tolkas i timezone). Valfritt. Standardvärdet är idag när inget datum anges, eller end_date − 30 days när bara end_date anges. Förflutna datum justeras tyst till idag.
string
Inkluderande slutdatum för fönstret i formatet YYYY-MM-DD (tolkas i timezone). Valfritt. Standardvärdet är idag + 30 dagar när inget datum anges, eller start_date + 30 days när bara start_date anges. Måste vara på eller efter start_date och inom 90 dagar från idag.
string
IANA-tidszon (t.ex. Europe/Berlin) som används för att tolka start_date / end_date och gruppera tider efter kalenderdatum. Valfritt — använder annars platsens egen tidszon. Själva starttiderna returneras alltid som UTC-tidpunkter (Z) och flyttas aldrig av den här parametern — tidsrutnätet utgår alltid från platsens egen tidszon; parametern styr bara vilken kalenderdag en tid grupperas under. Dagposterna i svaret täcker exakt start_date..end_date som kalenderdagar i den här tidszonen. Utelämna parametern om du inte visar tidsväljaren i en annan tidszon.

Svar

Vid framgång returnerar API:et 200 OK med ett enda tillgänglighetsobjekt.
string
obligatorisk
Återgiven platsidentifierare.
string
obligatorisk
IANA-tidszon som svaret visas i (t.ex. Europe/Berlin) — återger frågeparametern timezone när den anges, annars platsens egen tidszon.
integer
Avstånd i minuter mellan på varandra följande bokningsbara starttider. Platsens konfigurerade tidsintervall — varje tid i availability hamnar på det här intervallet. null bara när platsen saknar schemakonfiguration. Inte längden på en bokning: överlappande bokningar med olika starttider står inte i konflikt med varandra; bara krockar med exakt samma starttid räknas mot samtidiga bokningar.
array
obligatorisk
Bokningsbara tider per dag. Dagar utan bokningsbara tider utelämnas för att hålla svaret litet. Varje post har:

Felsvar