Перейти до основного вмісту
POST
Надішли клієнту один лист із повідомленням, що його лабораторні результати готові. Лист надходить на email профілю цього запису. Лист використовує загальний брендинг партнера: назву й логотип основної групи профілів для цього профілю. Він надсилається мовою language профілю, типово — англійською. Встанови для with_reports значення true, щоб прикріпити лабораторні звіти запису. До листа прикріплюється кожен звіт, який клієнт бачить у застосунку. Встанови false, щоб надіслати лише сповіщення. Додай note, щоб показати в листі особисту примітку — щонайбільше 1 000 символів. Кожен прикріплений звіт — це PDF, зашифрований за допомогою AES-256. Пароль — це date_of_birth профілю з 8 цифр у форматі DDMMYYYY без крапок: клієнт, який народився 1 лютого 1985 року, вводить 01021985. Лист пояснює клієнту цей формат, але ніколи не вказує саму дату народження. Кожен виклик надсилає один лист. Виклики не дедуплікуються: якщо ти викличеш ендпоїнт двічі, клієнт отримає два листи. Лист не надсилається, якщо:
  • Ще не надійшов жоден лабораторний звіт.
  • У профілі немає електронної адреси або вказана лише тимчасова адреса @aniva.email.
  • У профілі вимкнено транзакційні листи. Щоб знову їх увімкнути, встанови transactional_emails_enabled у значення true через Оновити профіль.
  • with_reports має значення true, а в профілі немає date_of_birth. Вкажи її через Оновити профіль або надішли запит із with_reports: false.
Потребує дозволу results_view.

Запит

Параметри шляху

string
обов'язково
Унікальний ідентифікатор (UUID) запису, результати якого потрібно надіслати листом.

Параметри тіла запиту

boolean
обов'язково
true прикріплює лабораторні звіти як PDF-файли, захищені паролем. false надсилає лише сповіщення про готовність результатів.
string
Особиста примітка, яка відображається в листі під сповіщенням. Щонайбільше 1 000 символів.

Відповідь

У разі успіху API повертає 200 OK.
string
обов'язково
Адреса, на яку надіслано лист: email профілю.
integer
обов'язково
Кількість прикріплених лабораторних звітів. 0, якщо with_reports має значення false.
string
обов'язково
Час надсилання листа в UTC (ISO 8601 із суфіксом Z).

Відповіді з помилками

Тіло помилки містить error — зрозуміле людині повідомлення — і reason — стабільний код. Помилки валідації та відсутність дозволу results_view не мають reason.