Ugrás a fő tartalomhoz
DELETE
Mondj le egy otthoni tesztkészlet-rendelést a státusza cancelled értékre állításával. A válaszban a lemondott otthoni tesztkészlet-rendelés érkezik vissza. Csak pending státuszú rendelést lehet lemondani. Amint dispatched állapotba kerül, a logisztikai partner már becsomagolta és felcímkézte a készletet, így a lemondás 409 hibát ad vissza — ahogy egy activated rendelés esetén is. Ha a készletet már megrendeltük a logisztikai partnertől, előbb náluk mondjuk le, mielőtt a tiédet lemondanánk, és a hívás sikertelen lesz, ha nem veszik vissza: 409, ha a készletet már becsomagolták és felcímkézték, 502, ha a logisztikai partner elutasította a lemondást, vagy nem volt elérhető. Minden hiba esetén semmi sem változik — a rendelés aktív marad, és az 502 biztonságosan újrapróbálható. Egy már cancelled státuszú rendelés lemondása 200 választ ad vissza az adott rendeléssel, függetlenül attól, milyen státuszból mondták le. A válasz tartalmazza az Idempotent-Replayed: true fejlécet, így megkülönböztetheted az ismétlést a tényleges műveletet végrehajtó hívástól. Lásd: Idempotencia. Szükséges hozzá a home_kit_orders_manage scope.

Kérés

Útvonalparaméterek

string
kötelező
A lemondandó otthoni tesztkészlet-rendelés egyedi azonosítója (UUID).

Válasz

Siker esetén az API 200 OK választ ad vissza a lemondott otthoni tesztkészlet-rendeléssel és a beágyazott profillal. Egy már korábban lemondott rendelés ugyanazt a 200 választ adja vissza.
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 státusza. Sikeres lemondás után cancelled lesz.
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ő
A lemondás előtt ehhez az otthoni tesztkészlet-rendeléshez hozzárendelt panel — mindig pontosan egy (egy otthoni tesztkészlet 1:1 arányban felel meg egy fizikai tesztkészlet-terméknek). A panel részleteit (név, biomarkerek) a Panelek listázása végponton kérdezheted le.
HomeKitOrderIndividualBiomarker[]
kötelező
Külön választható biomarkerek, amelyeket a lemondás előtt ehhez az otthoni tesztkészlet-rendeléshez rendeltek. A megjelenítési adatokhoz vesd össze az egyes biomarker_id értékeket a Biomarkerek listázása végponttal home_kit=true paraméterrel.
HomeKitOrderShipmentLink[]
kötelező
Csomagok, amelyeket a lemondás előtt ehhez az otthoni tesztkészlet-rendeléshez kapcsoltak, a legrégebbi kapcsolással kezdve. A teljes csomagadatokat a Szállítmányok listázása végponttal és a ?home_kit_order_id= paraméterrel olvashatod ki.

Hibaválaszok