Spring til hovedindhold
POST
Send kunden én e-mail, der fortæller dem, at deres laboratorieresultater er klar. E-mailen sendes til email på profilen for ordren på hjemmetestkittet. E-mailen bruger generisk partnerbranding: navnet og logoet for profilens primære profilgruppe. Den er på profilens language, engelsk som standard. Sæt with_reports til true for at vedhæfte kittets laboratorierapporter. I e-mailen vedhæftes alle rapporter, som kunden kan se i appen. Sæt feltet til false for kun at sende meddelelsen. Tilføj note for at vise en personlig note i e-mailen, højst 1.000 tegn. Hver vedhæftet rapport er en PDF krypteret med AES-256. Adgangskoden er profilens date_of_birth som 8 cifre, DDMMYYYY, uden punktummer: en kunde født den 1. februar 1985 indtaster 01021985. E-mailen oplyser kunden om dette format, men aldrig selve fødselsdatoen. Hvert kald sender én e-mail. Kald deduplikeres ikke: hvis du kalder endpointet to gange, får kunden to e-mails. E-mailen sendes ikke, når:
  • Der er ikke kommet nogen laboratorierapport endnu.
  • Profilen har ingen e-mailadresse eller kun en @aniva.email-pladsholderadresse.
  • Profilen har slået transaktionelle e-mails fra. Slå dem til igen ved at sætte transactional_emails_enabled til true med Opdater profil.
  • with_reports er true, og profilen har ingen date_of_birth. Angiv den med Opdater profil, eller send med with_reports: false.
  • Ordren er en af demoordrerne på hjemmetestkits. En demoordre har ingen kunde at sende e-mail til.
Kræver scopet results_view plus scopet home_kit_orders_view eller home_kit_orders_manage.

Forespørgsel

Stiparametre

string
påkrævet
Unik identifikator (UUID) for hjemmetestkitordren, hvis resultater skal sendes på e-mail.

Body-parametre

boolean
påkrævet
true vedhæfter laboratorierapporterne som adgangskodebeskyttede PDF-filer. false sender kun beskeden om, at resultaterne er klar.
string
En personlig note, som e-mailen viser under beskeden. Højst 1.000 tegn.

Svar

Ved succes returnerer API’et 200 OK.
string
påkrævet
Adressen, som e-mailen blev sendt til: profilens email.
integer
påkrævet
Antallet af vedhæftede laboratorierapporter. 0, når with_reports er false.
string
påkrævet
Tidspunktet, hvor e-mailen blev sendt, som et UTC-tidspunkt (ISO 8601 med Z-suffiks).

Fejlsvar

En fejl-body indeholder error, en menneskelæsbar besked, og reason, en stabil kode. Valideringsfejl og et manglende results_view-scope har ingen reason.