> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Tee ajanvaraus

> Vaiheittainen opas: etsi testipaikka, tarkista saatavuus ja tee ajanvaraus verinäytteenottoon Aniva API:lla.

Tämän oppaan avulla löydät testauspaikan, luot ajanvarauksen potilasprofiilille ja liität siihen tehtävät testipaneelit. Tee nämä vaiheet ennen kuin potilas saapuu verinäytteenottoon.

**1. Selaa saatavilla olevia paikkoja**

Hae tilillesi saatavilla olevien testauspaikkojen luettelo lähettämällä `GET`-pyyntö osoitteeseen `/api/v1/locations`.

```bash cURL theme={null}
curl --request GET \
  --url https://anivahealth.com/api/v1/locations \
  --header 'x-api-key: YOUR_API_KEY'
```

```javascript JavaScript theme={null}
const response = await fetch('https://anivahealth.com/api/v1/locations', {
  headers: {
    'x-api-key': 'YOUR_API_KEY',
  },
});

const locations = await response.json();
```

Vastaus on taulukko paikkaobjekteja:

```json theme={null}
[
  {
    "id": "b7e2d914-1c3a-4f08-9e5b-6d0f7a83c421",
    "name": "Aniva Berlin Mitte",
    "company_name": "Aniva GmbH",
    "street": "Friedrichstraße",
    "house_number": "112",
    "address_line_2": null,
    "city": "Berlin",
    "state": "Berlin",
    "postal_code": "10117",
    "country_name": "Germany",
    "country_code": "DE",
    "timezone": "Europe/Berlin",
    "contact_phone": "+4930987654321",
    "email": "berlin-mitte@anivahealth.com",
    "website": "https://anivahealth.com",
    "google_maps_url": null,
    "image_url": null,
    "open_hours": {
      "monday": [{ "open": "08:00", "close": "17:00" }],
      "tuesday": [{ "open": "08:00", "close": "17:00" }],
      "wednesday": [{ "open": "08:00", "close": "17:00" }],
      "thursday": [{ "open": "08:00", "close": "17:00" }],
      "friday": [{ "open": "08:00", "close": "15:00" }],
      "saturday": [],
      "sunday": []
    }
  }
]
```

> [!TIP]
>
> Käytä paikkaobjektin `timezone`-kenttää, kun muodostat `scheduled_at`-aikaleiman. Ajanvarausajan muuntaminen paikan paikalliseen aikavyöhykkeeseen auttaa välttämään varaamista aukioloaikojen ulkopuolelle.

> [!WARNING]
>
> Älä päättele varattavia aikoja pelkästään `open_hours`-kentästä. Kutsu päätepistettä [Hae saatavuus](https://docs.anivahealth.com/fi/api/locations/get-availability.md) ja varaa sen palauttama aikavälin alkamisaika — kyseinen aikataulu huomioi myös olemassa olevat varaukset, päiväkohtaiset poikkeukset ja vähimmäisvaroajan.

**2. Luo ajanvaraus**

Lähetä `POST`-pyyntö osoitteeseen `/api/v1/appointments` ja sisällytä siihen profiilin tunnus, paikan tunnus sekä haluamasi ajanvarausaika. Ajan on oltava päätepisteestä [Hae saatavuus](https://docs.anivahealth.com/fi/api/locations/get-availability.md) saatu aikavälin alkamisaika.

> [!NOTE]
>
> `scheduled_at`-arvon on oltava tuleva päivämäärä ja kellonaika ISO 8601 -muodossa, esimerkiksi `2026-05-12T07:30:00Z`. Menneisyydessä olevat aikaleimat hylätään `400`-virheellä, samoin kuin ajat, jotka jäävät Anivan operoimien paikkojen [12 tunnin vähimmäisvaroajan](https://docs.anivahealth.com/fi/api/appointments/create-appointment.md#vaehimmaeisennakkoaika) sisään.

> [!TIP]
>
> Tämän pyynnön toistaminen on turvallista. Profiililla voi olla vain yksi ajanvaraus paikkaa ja ajankohtaa kohden, joten uudelleen tai kahdesti lähetetty luontipyyntö palauttaa tilakoodin `409` ja olemassa olevan `appointment_id`-tunnuksen sen sijaan, että potilaalle varattaisiin kaksi aikaa.

```bash cURL theme={null}
curl --request POST \
  --url https://anivahealth.com/api/v1/appointments \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --data '{
    "profile_id": "a3f1c2e4-58b7-4d9e-b012-3c7f8a2e1d56",
    "location_id": "b7e2d914-1c3a-4f08-9e5b-6d0f7a83c421",
    "scheduled_at": "2026-05-12T07:30:00Z"
  }'
```

```javascript JavaScript theme={null}
const response = await fetch('https://anivahealth.com/api/v1/appointments', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'YOUR_API_KEY',
  },
  body: JSON.stringify({
    profile_id: 'a3f1c2e4-58b7-4d9e-b012-3c7f8a2e1d56',
    location_id: 'b7e2d914-1c3a-4f08-9e5b-6d0f7a83c421',
    scheduled_at: '2026-05-12T07:30:00Z',
  }),
});

const appointment = await response.json();
```

Onnistunut pyyntö palauttaa tilakoodin `201 Created` ja ajanvarausobjektin:

```json theme={null}
{
  "id": "c9d4e827-3b6f-4a1c-8d2e-5f0b9c7e3a12",
  "profile_id": "a3f1c2e4-58b7-4d9e-b012-3c7f8a2e1d56",
  "location_id": "b7e2d914-1c3a-4f08-9e5b-6d0f7a83c421",
  "scheduled_at": "2026-05-12T07:30:00Z",
  "status": "confirmed",
  "cancellation_reason": null,
  "results_ready_emails": [],
  "created_at": "2026-04-01T11:02:47Z",
  "updated_at": null,
  "profile": {
    "id": "a3f1c2e4-58b7-4d9e-b012-3c7f8a2e1d56",
    "handle": null,
    "first_name": "Emma",
    "last_name": "Müller",
    "email": "emma.muller@example.com",
    "phone": null,
    "sex": 2,
    "date_of_birth": "1990-04-15",
    "height": null,
    "weight": null,
    "language": "de",
    "transactional_emails_enabled": null,
    "created_at": "2026-04-01T09:14:22Z",
    "updated_at": null
  },
  "panels": [],
  "individual_biomarkers": [],
  "shipments": [],
  "lab_codes": []
}
```

Tallenna ajanvarauksen `id` — tarvitset sitä paneelien lisäämiseen ja verinäytteenoton vahvistamiseen.

**3. Lisää testipaneelit**

Liitä verinäytteestä tutkittavat testipaneelit lähettämällä `POST`-pyyntö osoitteeseen `/api/v1/appointments/{id}/panels`.

Paneelitunnukset ovat UUID-tunnuksia. Kutsu päätepistettä [Listaa paneelit](https://docs.anivahealth.com/fi/api/panels/list-panels.md) saadaksesi paneelit, jotka API-avaimesi voi tilata.

> [!WARNING]
>
> Paneeleja ei voi lisätä verinäytteenoton vahvistamisen jälkeen. Lisää kaikki tarvittavat paneelit ennen vahvistusta — katso lisätiedot oppaasta [Vahvista verinäytteenotto](https://docs.anivahealth.com/fi/guides/confirm-blood-draw.md).

```bash cURL theme={null}
curl --request POST \
  --url https://anivahealth.com/api/v1/appointments/c9d4e827-3b6f-4a1c-8d2e-5f0b9c7e3a12/panels \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --data '{
    "panel_ids": [
      "d1f5a302-7c8e-4b2d-9f1a-0e3c6d4b8a27",
      "e2a7b491-5d9f-4c3e-8a2b-1f4d7e5c9b38"
    ]
  }'
```

```javascript JavaScript theme={null}
const response = await fetch(
  'https://anivahealth.com/api/v1/appointments/c9d4e827-3b6f-4a1c-8d2e-5f0b9c7e3a12/panels',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': 'YOUR_API_KEY',
    },
    body: JSON.stringify({
      panel_ids: [
        'd1f5a302-7c8e-4b2d-9f1a-0e3c6d4b8a27',
        'e2a7b491-5d9f-4c3e-8a2b-1f4d7e5c9b38',
      ],
    }),
  }
);

const result = await response.json();
```

Onnistunut pyyntö palauttaa tilakoodin `200 OK`, mikä vahvistaa paneelien lisäämisen:

```json theme={null}
{
  "success": true
}
```

## Ajan muuttaminen tai peruuttaminen

Ajanvarauksen luomisen jälkeen voit vielä muokata sitä ennen verinäytteenoton vahvistamista:

* **Muuta aikaa tai paikkaa** — Lähetä `PATCH`-pyyntö osoitteeseen `/api/v1/appointments/{id}` ja sisällytä päivitettävät kentät. Katso [Päivitä ajanvaraus](https://docs.anivahealth.com/fi/api/appointments/update-appointment.md).
* **Peruuta** — Lähetä `DELETE`-pyyntö osoitteeseen `/api/v1/appointments/{id}`. Katso [Peruuta ajanvaraus](https://docs.anivahealth.com/fi/api/appointments/cancel-appointment.md).

> [!NOTE]
>
> Molemmat toiminnot ovat käytettävissä vain ennen verinäytteenottoa — eli kun ajanvarauksen tila on
> `pending` tai `confirmed`. Kun ajanvaraus siirtyy tilaan `blood_drawn`, sitä ei voi enää
> muokata.

## Virheenkäsittely

| Tila | Syy | Ratkaisu |
| - | - | - |
| `400 Bad Request` | Pakollinen kenttä puuttuu, `scheduled_at` on menneisyydessä, ei vastaa saatavilla olevaa aikajakoa tai jää 12 tunnin vähimmäisvaroajan sisään, tai `panel_ids` on tyhjä. | Tarkista virhevastauksen rungosta validointiviesti ja korjaa pyyntö. Vähimmäisvaroajan osalta valitse myöhempi aika päätepisteestä [Hae saatavuus](https://docs.anivahealth.com/fi/api/locations/get-availability.md). |
| `403 Forbidden` | API-avaimellasi ei ole oikeutta tähän toimintoon. | Ota yhteyttä Anivaan API-avaimesi käyttöoikeuksien vahvistamiseksi. |
| `404 Not Found` | `profile_id`- tai `location_id`-tunnusta ei ole olemassa, tai ajanvaraustunnus on virheellinen paneeleja lisättäessä. | Tarkista, että tunnukset ovat oikein ja kuuluvat tilillesi. |
| `409 Conflict` | Yritit lisätä paneeleja ajanvaraukseen tai muokata ajanvarausta, jonka tila on jo `blood_drawn` tai `cancelled`. | Vahvistamisen jälkeen muutoksia ei voi enää tehdä. |
| `409 Conflict` | Tällä profiililla on jo ajanvaraus kyseisessä paikassa ja kyseisenä ajankohtana, tai aika on täynnä. | Kaksoisvarauksen yhteydessä palautetaan olemassa oleva `appointment_id` — käytä sitä uuden yrityksen sijaan. Muussa tapauksessa valitse toinen aika. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.