Lähetykset
Listaa lähetyksen ajanvaraukset
Listaa lähetykseen liitetyt ajanvaraukset
GET
/
api
/
v1
/
shipments
/
{id}
/
appointments
curl --request GET \
--url https://anivahealth.com/api/v1/shipments/P2611194821/appointments \
--header 'x-api-key: YOUR_API_KEY'
[
{
"id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
"profile_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"location_id": "b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b",
"scheduled_at": "2026-04-15T08:30:00Z",
"status": "blood_drawn",
"created_at": "2026-04-01T10:00:00Z",
"updated_at": "2026-04-15T09:00:00Z",
"profile": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"date_of_birth": "1990-06-15",
"sex": 2
},
"panels": [
{
"panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
"added_at": "2026-04-01T10:05:00Z"
}
],
"individual_biomarkers": [],
"shipments": [
{
"id": "P2611194821",
"added_at": "2026-04-15T07:00:00Z"
}
]
}
]
{
"error": "Shipment not found"
}
Palauttaa kaikki tähän lähetykseen linkitetyt, pääsykontekstiisi kuuluvat ajanvarausobjektit,
vanhin linkitys ensin. Käänteinen haku
on Listaa lähetykset parametrilla
?appointment_id=.
Tyhjä taulukko, kun ajanvarauksia ei ole linkitetty. Jos haluat tarkistaa vain tunnukset ilman
täysiä ajanvaraustietoja, lue appointments-kenttä kutsusta Hae lähetys.
Vaatii käyttöoikeuden shipments_view, shipments_manage tai appointments_view.
Pyyntö
Polkuparametrit
Vastaus
Onnistuessaan API palauttaa tilakoodin200 OK ja taulukon ajanvarausobjekteja. Jokainen merkintä on
samaa muotoa kuin kutsussa Hae ajanvaraus.
Virhevastaukset
| Tila | Kuvaus |
|---|---|
400 | Virheellinen ID-muoto. |
403 | Pääsy kielletty — API-avaimellasi ei ole oikeutta tähän toimintoon tai lähetys on pääsykontekstisi ulkopuolella. |
404 | Lähetystä ei löytynyt. |
500 | Sisäinen palvelinvirhe. |
curl --request GET \
--url https://anivahealth.com/api/v1/shipments/P2611194821/appointments \
--header 'x-api-key: YOUR_API_KEY'
[
{
"id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
"profile_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"location_id": "b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b",
"scheduled_at": "2026-04-15T08:30:00Z",
"status": "blood_drawn",
"created_at": "2026-04-01T10:00:00Z",
"updated_at": "2026-04-15T09:00:00Z",
"profile": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"date_of_birth": "1990-06-15",
"sex": 2
},
"panels": [
{
"panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
"added_at": "2026-04-01T10:05:00Z"
}
],
"individual_biomarkers": [],
"shipments": [
{
"id": "P2611194821",
"added_at": "2026-04-15T07:00:00Z"
}
]
}
]
{
"error": "Shipment not found"
}
⌘I
curl --request GET \
--url https://anivahealth.com/api/v1/shipments/P2611194821/appointments \
--header 'x-api-key: YOUR_API_KEY'
[
{
"id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
"profile_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"location_id": "b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b",
"scheduled_at": "2026-04-15T08:30:00Z",
"status": "blood_drawn",
"created_at": "2026-04-01T10:00:00Z",
"updated_at": "2026-04-15T09:00:00Z",
"profile": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"date_of_birth": "1990-06-15",
"sex": 2
},
"panels": [
{
"panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
"added_at": "2026-04-01T10:05:00Z"
}
],
"individual_biomarkers": [],
"shipments": [
{
"id": "P2611194821",
"added_at": "2026-04-15T07:00:00Z"
}
]
}
]
{
"error": "Shipment not found"
}