Vai al contenuto principale
POST
Invia al cliente un’email per avvisarlo che i suoi risultati di laboratorio sono pronti. L’email viene inviata all’email del profilo dell’appuntamento. L’email usa un branding generico del partner: il nome e il logo del gruppo di profili principale del profilo. È nella language del profilo, inglese di default. Imposta with_reports su true per allegare i referti di laboratorio dell’appuntamento. L’email allega tutti i referti che il cliente può vedere nell’app. Impostalo su false per inviare solo l’avviso. Aggiungi note per mostrare una nota personale nell’email, fino a 1.000 caratteri. Ogni referto allegato è un PDF crittografato con AES-256. La password è la date_of_birth del profilo in 8 cifre, DDMMYYYY, senza punti: un cliente nato il 1° febbraio 1985 inserisce 01021985. L’email indica al cliente questo formato, ma mai la data di nascita stessa. Ogni chiamata invia un’email. Le chiamate non vengono deduplicate: se chiami l’endpoint due volte, il cliente riceve due email. L’email non viene inviata quando:
  • Non è ancora arrivato alcun referto di laboratorio.
  • Il profilo non ha un indirizzo email oppure ha solo un indirizzo segnaposto @aniva.email.
  • Il profilo ha disattivato le email transazionali. Per riattivarle, imposta transactional_emails_enabled su true con Aggiorna profilo.
  • with_reports è true e il profilo non ha una date_of_birth. Impostala con Aggiorna profilo oppure invia con with_reports: false.
Richiede lo scope results_view.

Richiesta

Parametri di percorso

string
obbligatorio
Identificatore univoco (UUID) dell’appuntamento di cui inviare i risultati via email.

Parametri del body

boolean
obbligatorio
true allega i referti di laboratorio come file PDF protetti da password. false invia solo l’avviso che i risultati sono pronti.
string
Una nota personale mostrata nell’email sotto l’avviso. Al massimo 1.000 caratteri.

Risposta

In caso di successo, l’API restituisce 200 OK.
string
obbligatorio
L’indirizzo a cui è stata inviata l’email: l’email del profilo.
integer
obbligatorio
Il numero di referti di laboratorio allegati. 0 quando with_reports è false.
string
obbligatorio
Quando è stata inviata l’email, come istante UTC (ISO 8601 con suffisso Z).

Risposte di errore

Il corpo di un errore contiene error, un messaggio leggibile, e reason, un codice stabile. Gli errori di validazione e la mancanza dello scope results_view non hanno reason.