Palauttaa yksittäisen toimipisteen varattavien aikojen aloitusajat pyydetyltä aikaväliltä. Ajat
luodaan toimipisteen open_hours-tiedoista, yleiset ja toimipistekohtaiset estetyt päivät ohitetaan
ja jo varatut Aniva-ajanvaraukset vähennetään, joten tulos vastaa sitä, mitä potilaasi voivat
todellisuudessa varata asiakaspuolella.Vaatii appointments_schedule-käyttöoikeuden. Toimipisteen on myös kuuluttava API-avaimesi toimipisteryhmän käyttöoikeuskontekstiin.
Käytä tätä päätepistettä sen sijaan, että päättelisit saatavuuden staattisista open_hours-tiedoista,
jotka päätepiste Listaa toimipisteet palauttaa — vain tämä
päätepiste huomioi reaaliaikaiset varaukset, päiväkohtaiset aikataulupoikkeukset ja 12 tunnin
vähimmäisvaroajan Anivan ylläpitämissä
toimipisteissä. Jokainen täältä palautettu aika on varattavissa sellaisenaan.
Vastaukset sisältävät otsikon Cache-Control: private, max-age=30, stale-while-revalidate=60, joten
selain voi tarjota välimuistissa olevaa vastausta enintään ~30 sekunnin ajan — kyseisen ikkunan
sisällä varattu aika voi yhä näkyä varattavana seuraavaan päivitykseen asti. Näytä ristiriidat myös
varaushetkellä.
Aikavälin alkupäivä (mukaan lukien) muodossa YYYY-MM-DD (tulkitaan aikavyöhykkeessä timezone).
Valinnainen. Oletuksena tämä päivä, kun kumpaakaan päivämäärää ei anneta, tai end_date − 30 days, kun vain end_date annetaan. Menneet päivämäärät rajataan hiljaisesti tähän päivään.
string
Aikavälin loppupäivä (mukaan lukien) muodossa YYYY-MM-DD (tulkitaan aikavyöhykkeessä timezone).
Valinnainen. Oletuksena tämä päivä + 30 päivää, kun kumpaakaan päivämäärää ei anneta, tai
start_date + 30 days, kun vain start_date annetaan. Täytyy olla aikaisintaan start_date
ja enintään 90 päivän päässä tästä päivästä.
string
IANA-aikavyöhyke (esim. Europe/Berlin), jota käytetään parametrien start_date / end_date
tulkintaan ja aikojen ryhmittelyyn kalenteripäivittäin. Valinnainen — oletuksena toimipisteen oma
aikavyöhyke. Aikojen aloitusajat esitetään aina UTC-ajanhetkinä (Z) eivätkä ne muutu tämän
parametrin myötä — aikaruudukko muodostetaan aina toimipisteen omasta aikavyöhykkeestä; parametri
vaikuttaa vain siihen, minkä kalenteripäivän alle aika ryhmitellään. Vastauksen päivämerkinnät
kattavat täsmälleen välin start_date..end_date tämän aikavyöhykkeen kalenteripäivinä. Jätä
parametri pois, ellet näytä valitsinta toisella aikavyöhykkeellä.
Vastaus
Onnistuessaan API palauttaa 200 OK sekä yhden saatavuusobjektin.
string
vaadittu
Toistettu toimipisteen tunniste.
string
vaadittu
IANA-aikavyöhyke, jossa vastaus esitetään (esim. Europe/Berlin) — toistaa kyselyparametrin
timezone, jos se on annettu, muuten toimipisteen oman aikavyöhykkeen.
integer
Peräkkäisten varattavien aikojen aloitusaikojen väli minuutteina. Toimipisteelle määritetty
aikaväliaskel — jokainen kentän availability aika osuu tälle ruudukolle. null vain silloin,
kun toimipisteellä ei ole aikataulumäärityksiä. Ei ole ajanvarauksen kestoikkuna: eri
aloitusaikojen päällekkäiset varaukset eivät ole ristiriidassa; vain täsmälleen saman
aloitusajan osumat lasketaan samanaikaisuuteen.
array
vaadittu
Päiväkohtaiset varattavat ajat. Päivät, joilla ei ole varattavia aikoja, jätetään pois vastauksen
pitämiseksi tiiviinä. Jokainen merkintä sisältää:
Aikojen aloitusajat UTC-ajanhetkinä (ISO 8601 Z-päätteellä) nousevassa järjestyksessä.
Virhevastaukset
Tila
Kuvaus
400
Virheellinen toimipisteen tunniste, virheellinen päivämäärän tai aikavyöhykkeen muoto, end_date ennen parametria start_date tai end_date yli 90 päivän päässä tulevaisuudessa.
403
Kielletty — appointments_schedule-käyttöoikeus puuttuu tai toimipiste ei kuulu käyttöoikeuskontekstiisi.
404
Toimipistettä ei löytynyt tai se ei ole aktiivinen.
500
Sisäinen palvelinvirhe.
curl --request GET \ --url 'https://anivahealth.com/api/v1/locations/b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b/availability?start_date=2026-05-01&end_date=2026-05-07' \ --header 'x-api-key: YOUR_API_KEY'