Zum Hauptinhalt springen
POST
Sende dem Kunden eine E-Mail, die ihn darüber informiert, dass seine Laborergebnisse vorliegen. Die E-Mail geht an die email des Profils dieses Termins. Die E-Mail nutzt generisches Partner-Branding: den Namen und das Logo der primären Profilgruppe des Profils. Sie ist in der language des Profils, standardmäßig auf Englisch. Setze with_reports auf true, um die Laborberichte des Termins anzuhängen. Die E-Mail hängt jeden Bericht an, den der Kunde in der App sehen kann. Setze den Wert auf false, um nur die Benachrichtigung zu senden. Füge note hinzu, um eine persönliche Nachricht in der E-Mail anzuzeigen, höchstens 1.000 Zeichen. Jeder angehängte Bericht ist ein mit AES-256 verschlüsseltes PDF. Das Passwort ist das date_of_birth des Profils als 8 Ziffern, DDMMYYYY, ohne Punkte: Ein Kunde, der am 1. Februar 1985 geboren wurde, gibt 01021985 ein. Die E-Mail nennt dem Kunden dieses Format, aber niemals das Geburtsdatum selbst. Jeder Aufruf sendet eine E-Mail. Aufrufe werden nicht dedupliziert: Wenn du den Endpunkt zweimal aufrufst, erhält der Kunde zwei E-Mails. Die E-Mail wird nicht gesendet, wenn:
  • noch kein Laborbericht eingegangen ist.
  • das Profil keine E-Mail-Adresse oder nur eine Platzhalteradresse mit @aniva.email hat.
  • das Profil transaktionale E-Mails deaktiviert hat. Um sie wieder zu aktivieren, setze transactional_emails_enabled mit Profil aktualisieren auf true.
  • with_reports auf true steht und das Profil kein date_of_birth hat. Lege es mit Profil aktualisieren fest oder sende mit with_reports: false.
Erfordert den Scope results_view.

Anfrage

Pfadparameter

string
erforderlich
Eindeutige Kennung (UUID) des Termins, dessen Ergebnisse per E-Mail gesendet werden sollen.

Body-Parameter

boolean
erforderlich
true hängt die Laborberichte als passwortgeschützte PDF-Dateien an. false sendet nur die Benachrichtigung, dass die Ergebnisse vorliegen.
string
Eine persönliche Nachricht, die in der E-Mail unter der Benachrichtigung angezeigt wird. Höchstens 1.000 Zeichen.

Antwort

Bei Erfolg gibt die API 200 OK zurück.
string
erforderlich
Die Adresse, an die die E-Mail gesendet wurde: die email des Profils.
integer
erforderlich
Die Anzahl der angehängten Laborberichte. 0, wenn with_reports false ist.
string
erforderlich
Zeitpunkt des E-Mail-Versands als UTC-Zeitstempel (ISO 8601 mit Z-Suffix).

Fehlerantworten

Ein Fehler-Body enthält error, eine menschenlesbare Meldung, und reason, einen stabilen Code. Validierungsfehler und ein fehlender results_view-Scope haben kein reason.