Saltar al contingut principal
POST
Envia al client un correu electrònic per avisar-lo que els seus resultats de laboratori ja estan a punt. El correu s’envia a l’email del perfil de la comanda de kit de prova a casa. El correu electrònic fa servir la marca genèrica del soci: el nom i el logotip del grup de perfils principal del perfil. És en el language del perfil, en anglès per defecte. Defineix with_reports com a true per adjuntar els informes de laboratori del kit. El correu adjunta tots els informes que el client pot veure a l’app. Defineix-lo com a false per enviar només l’avís. Afegeix note per mostrar una nota personal al correu, de com a màxim 1.000 caràcters. Cada informe adjunt és un PDF xifrat amb AES-256. La contrasenya és el camp date_of_birth del perfil en 8 dígits, DDMMYYYY, sense punts: un client nascut l’1 de febrer de 1985 escriu 01021985. El correu indica aquest format al client, però mai la data de naixement en si. Cada crida envia un correu electrònic. Les crides no es dedupliquen: si crides l’endpoint dues vegades, el client rep dos correus electrònics. El correu electrònic no s’envia quan:
  • Encara no ha arribat cap informe de laboratori.
  • El perfil no té adreça electrònica o només té una adreça provisional @aniva.email.
  • El perfil té desactivats els correus transaccionals. Per tornar-los a activar, defineix transactional_emails_enabled com a true amb Actualitza el perfil.
  • with_reports és true i el perfil no té date_of_birth. Defineix-la amb Actualitza el perfil o envia’l amb with_reports: false.
  • La comanda és una de les comandes de demostració de kits de prova a casa. Una comanda de demostració no té cap client a qui enviar el correu.
Requereix l’àmbit results_view i l’àmbit home_kit_orders_view o home_kit_orders_manage.

Sol·licitud

Paràmetres de ruta

string
requerit
Identificador únic (UUID) de la comanda de kit de prova a casa de la qual vols enviar els resultats per correu.

Paràmetres del cos

boolean
requerit
true adjunta els informes de laboratori com a fitxers PDF protegits amb contrasenya. false envia només l’avís que els resultats estan a punt.
string
Una nota personal que el correu mostra a sota de l’avís. Com a màxim 1.000 caràcters.

Resposta

En cas d’èxit, l’API retorna 200 OK.
string
requerit
L’adreça a la qual s’ha enviat el correu: l’email del perfil.
integer
requerit
El nombre d’informes de laboratori adjunts. 0 quan with_reports és false.
string
requerit
Quan s’ha enviat el correu, com a instant UTC (ISO 8601 amb el sufix Z).

Respostes d’error

El cos d’un error conté error, un missatge llegible per a humans, i reason, un codi estable. Els errors de validació i la falta de l’àmbit results_view no tenen reason.