Ana içeriğe atla
PATCH
Bir evde test kiti siparişinin teslimat adresini, panelini, meta verilerini veya sonuçlar hazır e-postalarını güncelle. Yalnızca değiştirmek istediğin alanları ekle. Teslimat adresi ve panel yalnızca sipariş pending durumundayken değiştirilebilir, çünkü fiziksel kit sevk anında gönderilir. metadata kendi kayıtların içindir ve siparişin tüm yaşam döngüsü boyunca yazılabilir kalır. Panel ekleme/kaldırma uç noktaları yoktur: bir evde test kiti tam olarak bir panel taşır (fiziksel bir kit ürünüyle 1:1 eşleşir), bu yüzden anlamlı tek panel işlemi burada yaptığın değişimdir. home_kit_orders_manage kapsamını gerektirir.

İstek

Yol parametreleri

string
gerekli
Güncellenecek evde test kiti siparişinin benzersiz kimliği (UUID).

Gövde parametreleri

Tüm gövde parametreleri isteğe bağlıdır — yalnızca değiştirmek istediğin alanları ekle.
object
Kitin gönderileceği adres — iki biçimden biri: bilinen bir test konumuna başvuran { 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ı alan adları). Tam olarak birini sağla — bir konum başvurusu veya satır içi adres, ikisini birden değil.
Packstation veya Postfiliale (yalnızca Almanya): street alanını Packstation veya Postfiliale, house_number alanını üç haneli istasyon numarası ve address_line_2 alanını alıcının DHL Postnummer bilgisi (6–10 hane, boşluk kullanılabilir) olarak ayarla. Postnummer olmadan paket için kargo kaydı oluşturulamaz. Postfach desteklenmez.
string
Mevcut olanın yerine eklenecek panelin UUID’si — kit başına tam olarak bir panel olduğu için değişim tek anlamlı işlemdir. Yalnızca sipariş pending durumundayken ve yalnızca Aniva’nın bir gönderim kiti ürünüyle yapılandırdığı bir panele yapılabilir (aksi halde 422); zaten ekli panele geçiş bir işlem yapmaz.
object
Kendi anahtar/değer çiftlerin. Mevcut meta verilerin yerini almak yerine onlarla birleştirilir: göndermediğin anahtarlar korunur, null değeriyle gönderilen bir anahtar silinir ve boş bir {} nesnesi her şeyi temizler. Sınırlar Evde test kiti siparişi oluştur ile aynıdır ve doğrulama hep ya da hiç şeklinde çalışır — herhangi bir anahtar reddedilirse hiçbir şey yazılmaz. metadata içine asla kişisel veya klinik veri koyma — hasta verisi olarak işlenmez.
string[]
Tüm laboratuvar sonuçları kesinleştiğinde her birine bir e-posta gönderilecek en fazla 5 adreslik listeyi değiştirir. E-postaları kapatmak için [] gönder. cancelled dışındaki her durumda düzenlenebilir. Anahtarının hasta için results_view erişimine sahip olması gerekir, aksi halde 403 döner. Bkz. Sonuçlar hazır e-postaları.

Yanıt

İşlem başarılı olduğunda API, güncellenmiş evde test kiti siparişi ve gömülü profiliyle birlikte 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
Mevcut evde test kiti sipariş durumu. pending, dispatched, activated veya cancelled değerlerinden biri.
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 ekli panel — her zaman tam olarak bir tanedir (bir evde test kiti fiziksel bir kit ürünüyle 1:1 eşleşir), panel_id gönderdiğinde yerinde değiştirilir. Panel ayrıntılarına (ad, biyobelirteçler) Panelleri listele üzerinden bak.
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.

Hata yanıtları