Ugrás a fő tartalomhoz
POST
Küldj az ügyfélnek egy e-mailt arról, hogy elkészültek a laboreredményei. Az e-mail az otthoni tesztkészlet-rendelés profiljának email címére megy. Az e-mail általános partnerarculatot használ: a profil elsődleges profilcsoportjának nevét és logóját. A nyelve a profil language értéke, alapértelmezés szerint angol. Állítsd a with_reports mezőt true értékre a tesztkészlet laboratóriumi leleteinek csatolásához. Az e-mail minden olyan leletet csatol, amelyet az ügyfél az alkalmazásban lát. Állítsd false értékre, ha csak az értesítést szeretnéd elküldeni. Adj hozzá note mezőt, ha személyes megjegyzést szeretnél megjeleníteni az e-mailben, legfeljebb 1 000 karakterben. Minden csatolt lelet AES-256 titkosítású PDF. A jelszó a profil date_of_birth értéke 8 számjegyként, DDMMYYYY formátumban, pontok nélkül: egy 1985. február 1-jén született ügyfél ezt írja be: 01021985. Az e-mail közli az ügyféllel ezt a formátumot, de magát a születési dátumot soha. Minden hívás egy e-mailt küld. A hívások nincsenek deduplikálva: ha kétszer hívod meg a végpontot, az ügyfél két e-mailt kap. Nem küldünk e-mailt, ha:
  • Még nem érkezett laboratóriumi lelet.
  • A profilnak nincs e-mail-címe, vagy csak egy helyőrző @aniva.email címe van.
  • A profil kikapcsolta a tranzakciós e-maileket. Az újbóli bekapcsolásukhoz állítsd a transactional_emails_enabled mezőt true értékre a Profil frissítése végponttal.
  • A with_reports értéke true, és a profilnak nincs date_of_birth mezője. Állítsd be a Profil frissítése végponttal, vagy küldd el with_reports: false értékkel.
  • A rendelés egy demó otthoni tesztkészlet-rendelés. A demó rendeléshez nem tartozik ügyfél, akinek e-mailt lehetne küldeni.
A results_view jogosultsági kör, valamint a home_kit_orders_view vagy a home_kit_orders_manage jogosultsági kör szükséges hozzá.

Kérés

Útvonalparaméterek

string
kötelező
Annak az otthoni tesztkészlet-rendelésnek az egyedi azonosítója (UUID), amelynek az eredményeit e-mailben küldöd el.

Törzsparaméterek

boolean
kötelező
A true érték jelszóval védett PDF-fájlként csatolja a laborleleteket. A false érték csak azt az értesítést küldi el, hogy az eredmények elkészültek.
string
Személyes megjegyzés, amelyet az e-mail az értesítés alatt jelenít meg. Legfeljebb 1 000 karakter.

Válasz

Siker esetén az API 200 OK választ ad vissza.
string
kötelező
A cím, amelyre az e-mail ment: a profil email címe.
integer
kötelező
A csatolt laborleletek száma. 0, ha a with_reports értéke false.
string
kötelező
Az e-mail elküldésének ideje, UTC-időpontként (ISO 8601 formátum Z végződéssel).

Hibaválaszok

A hibatörzs tartalmazza az error mezőt, amely ember által olvasható üzenet, valamint a reason mezőt, amely stabil kód. Validációs hibáknál és hiányzó results_view scope esetén nincs reason.