Ana içeriğe atla
POST
Müşteriye laboratuvar sonuçlarının hazır olduğunu bildiren bir e-posta gönder. E-posta, evde test kiti siparişinin profilindeki email adresine gider. E-posta genel iş ortağı markalamasını kullanır: profilin birincil profil grubunun adı ve logosu. Profilin language dilindedir, varsayılan olarak İngilizcedir. Kitin laboratuvar raporlarını eklemek için with_reports alanını true olarak ayarla. E-postaya müşterinin uygulamada görebildiği her rapor eklenir. Yalnızca bildirimi göndermek için false olarak ayarla. E-postada en fazla 1.000 karakterlik kişisel bir not göstermek için note ekle. Eklenen her rapor, AES-256 ile şifrelenmiş bir PDF’dir. Şifre, profilin date_of_birth değerinin noktasız 8 haneli DDMMYYYY biçimidir: 1 Şubat 1985 doğumlu bir müşteri 01021985 yazar. E-posta müşteriye bu biçimi söyler ama doğum tarihinin kendisini asla yazmaz. Her çağrı bir e-posta gönderir. Çağrılar tekilleştirilmez: uç noktayı iki kez çağırırsan müşteri iki e-posta alır. E-posta şu durumlarda gönderilmez:
  • Henüz laboratuvar raporu gelmedi.
  • Profilde e-posta adresi yok ya da yalnızca yer tutucu bir @aniva.email adresi var.
  • Profil işlemsel e-postaları kapattı. Bunları yeniden açmak için Profili güncelle ile transactional_emails_enabled alanını true olarak ayarla.
  • with_reports değeri true ve profilde date_of_birth yok. Bunu Profili güncelle ile ayarla veya with_reports: false ile gönder.
  • Sipariş, demo evde test kiti siparişlerinden biri. Demo siparişin e-posta gönderilecek müşterisi yok.
results_view kapsamı ile birlikte home_kit_orders_view veya home_kit_orders_manage kapsamını gerektirir.

İstek

Yol parametreleri

string
gerekli
Sonuçları e-posta ile gönderilecek evde test kiti siparişinin benzersiz kimliği (UUID).

Gövde parametreleri

boolean
gerekli
true laboratuvar raporlarını şifre korumalı PDF dosyaları olarak ekler. false yalnızca sonuçların hazır olduğuna dair bildirimi gönderir.
string
E-postanın bildirimin altında gösterdiği kişisel not. En fazla 1.000 karakter.

Yanıt

Başarılı olduğunda API 200 OK döndürür.
string
gerekli
E-postanın gönderildiği adres: profilin email değeri.
integer
gerekli
Eklenen laboratuvar raporu sayısı. with_reports değeri false olduğunda 0.
string
gerekli
E-postanın gönderildiği zaman, UTC anı olarak (Z son ekli ISO 8601).

Hata yanıtları

Hata gövdesinde okunabilir bir mesaj olan error ve sabit bir kod olan reason bulunur. Doğrulama hataları ve eksik results_view kapsamı için reason bulunmaz.