Ugrás a fő tartalomhoz
GET
Kérd le az otthoni tesztkészlet-rendelések listáját. Egy otthoni tesztkészlet-rendelés egy otthon elvégezhető, postai tesztkészlet kiküldését jelenti — az Aniva kiszállítja a tesztkészletet, a páciens otthon maga veszi le a mintát, és postán visszaküldi. Minden otthoni tesztkészlet-rendelés tartalmazza a beágyazott páciensprofilt. Ha megadod a profile_id paramétert, az adott profil összes otthoni tesztkészlet-rendelését adja vissza. Ha kihagyod, az összes hozzáférhető otthoni tesztkészlet-rendelést adja vissza. A home_kit_orders_view vagy a home_kit_orders_manage jogosultsági kör szükséges hozzá.

Kérés

Lekérdezési paraméterek

string
Szűrés profil-UUID alapján. Ha megadod, az adott profil összes otthoni tesztkészlet-rendelését visszaadja.
string
Szűrés laboratóriumi kód alapján (pontos egyezés) — a kézben lévő fizikai tesztkészlethez a rányomtatott kód alapján keresheted meg a hozzá tartozó rendelést, pl. az Aktiválás meghívása előtt.

Válasz

Siker esetén az API 200 OK választ ad vissza otthoni tesztkészlet-rendelés objektumok tömbjével.
string
kötelező
Az otthoni tesztkészlet-rendelés egyedi azonosítója (UUID).
string
kötelező
Annak a profilnak az UUID-ja, amelyhez ez az otthoni tesztkészlet-rendelés tartozik.
string
kötelező
Az otthoni tesztkészlet-rendelés aktuális állapota. A lehetséges értékek egyike: pending, dispatched, activated vagy cancelled. A laboratóriumi eredmények elkészülésének részletes állapota az Eredmények lekérése végpontból olvasható ki.
object
kötelező
A cím, ahová a tesztkészletet postázzuk — két formátum egyike: vagy egy { location_id }, amely egy ismert tesztelési helyszínre hivatkozik, vagy a beágyazott címmezők (name, street, city, postal_code, country_code; a company_name / house_number / address_line_2 / state / phone / email opcionális — ugyanaz a mezőkészlet, mint a helyszínek API-ban). Pontosan az egyiket add meg — vagy helyszínhivatkozást, vagy beágyazott címet, de ne mindkettőt.
string
A laboratóriumi mintakód, amely alatt az eredmények beérkeznek — a fizikai készletre van nyomtatva, és ezt olvassa le a páciens a dobozról aktiválási kódként. null, amíg a készletet nem csomagolták be. Csak olvasható.
string
kötelező
Az Aktiválás végponton keresztül jelentett mintavételi időbélyeg — amikor a páciens levette a mintát. null, amíg a készletet nem aktiválták.
string
Az az otthoni tesztkészlet-rendelés, amelyet ez helyettesít, ha cserekészletről van szó. Normál rendelés esetén null. Lásd: Otthoni tesztkészlet-rendelés létrehozása.
string
A cserekészlet küldésének oka. Normál rendelés esetén null.
string[]
kötelező
Címek, amelyek mindegyike egy-egy e-mailt kap, amint minden laboreredmény végleges, kisbetűvel. Kikapcsolva üres. Lásd: Eredmények elkészültéről szóló e-mailek.
object
kötelező
A partner által megadott kulcs-érték párok, változatlanul visszaadva. Mindig jelen van — {} értékkel, ha nincs megadva.
string
kötelező
Az otthoni tesztkészlet-rendelés létrehozásának ISO 8601 időbélyege.
string
Az utolsó frissítés ISO 8601 időbélyege. Lehet null.
object
kötelező
Az ehhez az otthoni tesztkészlet-rendeléshez tartozó páciensprofil.
HomeKitOrderPanel[]
kötelező
Az ehhez az otthoni tesztkészlet-rendeléshez csatolt panel — mindig pontosan egy (egy otthoni tesztkészlet 1:1 arányban felel meg egy fizikai tesztkészlet-terméknek), amely pending állapotban a Frissítés végponttal cserélhető. A panel részleteit (név, biomarkerek) a Panelek listázása végponton találod meg.
HomeKitOrderIndividualBiomarker[]
kötelező
Ehhez az otthoni tesztkészlet-rendeléshez panelen kívül csatolt egyedi biomarkerek. A megjelenítési adatokhoz vesd össze az egyes biomarker_id értékeket a home_kit=true paraméterrel hívott Biomarkerek listázása végpont adataival.
HomeKitOrderShipmentLink[]
kötelező
Az ehhez az otthoni tesztkészlet-rendeléshez kapcsolt csomagok, a legrégebben kapcsolttal kezdve — jellemzően a páciensnek küldött tesztkészlet és a laboratóriumba visszaküldött minta. Üres, amíg a logisztika ki nem nyomtat egy címkét. A csomagok teljes adatait a Szállítmányok listázása végponttal és a ?home_kit_order_id= paraméterrel olvashatod le.

Ismételt hívások

Az Aniva minden API-kulcshoz 5 percig tárolja ennek a végpontnak a válaszát. Ezen az időn belül egy ismételt hívás a tárolt választ kapja vissza. A Cache-Status és az Age fejléc mutatja, hogy a válasz tárolt, és mennyi idős. Ha azonnal értesülni szeretnél egy változásról, iratkozz fel a home_kit_order.created webhook-eseményre és az egyes állapotok eseményeire, például a home_kit_order.activated eseményre. Lásd: Ismételt lekérések.

Hibaválaszok