Ana içeriğe atla
GET
Evde test kiti siparişlerinin listesini al. Evde test kiti siparişi, eve postalanan kendi kendine uygulanabilen bir test kiti gönderir — Aniva kiti kargolar, hasta evde kendi numunesini alır ve postayla geri gönderir. Her evde test kiti siparişi yerleşik hasta profilini içerir. profile_id verildiğinde bu profil için tüm evde test kiti siparişlerini döndürür. Verilmediğinde erişilebilen tüm evde test kiti siparişlerini döndürür. home_kit_orders_view veya home_kit_orders_manage kapsamını gerektirir.

İstek

Sorgu parametreleri

string
Profil UUID’sine göre filtrele. Verildiğinde bu profil için tüm evde test kiti siparişleri döndürülür.
string
Laboratuvar koduna göre filtrele (tam eşleşme) — örneğin Etkinleştir çağrısından önce elindeki fiziksel kiti üzerinde basılı kodla ilgili siparişle eşleştir.

Yanıt

Başarılı olduğunda API, evde test kiti siparişi nesnelerinden oluşan bir diziyle 200 OK döndürür.
string
gerekli
Benzersiz evde test kiti siparişi kimliği (UUID).
string
gerekli
Bu evde test kiti siparişinin ait olduğu profilin UUID’si.
string
gerekli
Güncel evde test kiti sipariş durumu. pending, dispatched, activated veya cancelled değerlerinden biri. Laboratuvar sonuçlarının tamamlanma ayrıntısı Sonuçları al üzerinden elde edilir.
object
gerekli
Kitin postalanacağı adres — iki biçimden biri: bilinen bir test konumuna referans veren { location_id } veya satır içi adres alanları (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email isteğe bağlı — konumlar API’siyle aynı terminoloji). Tam olarak birini belirt — konum referansı veya satır içi adres, ikisi birden değil.
string
Sonuçların altında raporlandığı laboratuvar örnek kodu — fiziksel kitin üzerinde basılıdır ve hastanın kutudan etkinleştirme kodu olarak okuduğu koddur. Kit paketlenene kadar null. Salt okunur.
string
gerekli
Etkinleştir üzerinden bildirilen örnek alma zaman damgası — hastanın örneğini ne zaman aldığı. Kit etkinleştirilene kadar null.
string
Bu bir değişim kiti olduğunda, yerini aldığı evde test kiti siparişi. Normal bir siparişte null. Bkz. Evde test kiti siparişi oluştur.
string
Değişim kitinin neden gönderildiği. Normal bir siparişte null.
string[]
gerekli
Tüm laboratuvar sonuçları kesinleştiğinde her birine bir e-posta gönderilen, küçük harfe çevrilmiş adresler. Kapalıyken boştur. Bkz. Sonuçlar hazır e-postaları.
object
gerekli
İş ortağı tarafından tanımlanan ve aynen geri döndürülen anahtar/değer çiftleri. Her zaman mevcuttur — ayarlanmadığında {}.
string
gerekli
Evde test kiti siparişinin oluşturulduğu zamanın ISO 8601 zaman damgası.
string
Son güncellemenin ISO 8601 zaman damgası. null olabilir.
object
gerekli
Bu evde test kiti siparişiyle ilişkili hasta profili.
HomeKitOrderPanel[]
gerekli
Bu evde test kiti siparişine bağlı panel — her zaman tam olarak bir tane (bir evde test kiti fiziksel bir kit ürünüyle 1:1 eşleşir), pending durumundayken Güncelle ile değiştirilebilir. Panel ayrıntılarını (ad, biyobelirteçler) Panelleri listele ile incele.
HomeKitOrderIndividualBiomarker[]
gerekli
Herhangi bir panel dışında bu evde test kiti siparişine eklenen tekil biyobelirteçler. Görüntüleme verileri için her biomarker_id değerini home_kit=true ile Biyobelirteçleri listele üzerinden eşleştir.
HomeKitOrderShipmentLink[]
gerekli
Bu evde test kiti siparişine bağlı kargolar, en eski bağlantıdan başlayarak — normalde hastaya gönderilen kit ve laboratuvara geri giden numune. Gönderim birimi etiket basana kadar boştur. Kargoların tüm ayrıntılarını ?home_kit_order_id= ile Gönderileri listele üzerinden oku.

Tekrarlanan çağrılar

Aniva bu uç noktanın yanıtını her API anahtarı için 5 dakika boyunca saklar. Bu süre içinde yapılan yinelenen bir çağrı saklanan yanıtı alır. Cache-Status ve Age başlıkları yanıtın saklandığını ve ne kadar eski olduğunu gösterir. Bir değişiklikten hemen haberdar olmak için home_kit_order.created ve her durumun webhook olayına, örneğin home_kit_order.activated olayına abone ol. Bkz. Tekrarlı okumalar.

Hata yanıtları