Siirry pääsisältöön
POST
Lähetä asiakkaalle yksi sähköposti, jossa kerrotaan laboratoriotulosten olevan valmiit. Sähköposti lähetetään kotitestipakkauksen tilauksen profiilin email-osoitteeseen. Sähköpostissa käytetään yleistä kumppanibrändäystä: profiilin ensisijaisen profiiliryhmän nimeä ja logoa. Se on profiilin language-kielellä, oletuksena englanniksi. Aseta with_reports arvoon true, kun haluat liittää pakkauksen laboratorioraportit mukaan. Sähköpostiin liitetään jokainen raportti, jonka asiakas näkee sovelluksessa. Aseta arvoksi false, kun haluat lähettää vain ilmoituksen. Lisää note, jos haluat näyttää sähköpostissa henkilökohtaisen viestin, enintään 1 000 merkkiä. Jokainen liitetty raportti on AES-256-salattu PDF. Salasana on profiilin date_of_birth 8 numerona muodossa DDMMYYYY ilman pisteitä: 1. helmikuuta 1985 syntynyt asiakas kirjoittaa 01021985. Sähköposti kertoo asiakkaalle tämän muodon, mutta ei koskaan itse syntymäaikaa. Jokainen kutsu lähettää yhden sähköpostin. Päällekkäisiä kutsuja ei suodateta: jos kutsut päätepistettä kahdesti, asiakas saa kaksi sähköpostia. Sähköpostia ei lähetetä, kun:
  • Yhtään laboratorioraporttia ei ole vielä saapunut.
  • Profiililla ei ole sähköpostiosoitetta tai sillä on vain paikkamerkkinä oleva @aniva.email-osoite.
  • Profiilissa on poistettu tapahtumasähköpostit käytöstä. Ota ne uudelleen käyttöön asettamalla transactional_emails_enabled arvoon true päätepisteellä Päivitä profiili.
  • with_reports on true, eikä profiililla ole date_of_birth-arvoa. Aseta se päätepisteellä Päivitä profiili tai lähetä arvolla with_reports: false.
  • Tilaus on yksi kotitestipakkausten demotilauksista. Demotilauksella ei ole asiakasta, jolle sähköpostin voisi lähettää.
Vaatii results_view-käyttöoikeuden sekä home_kit_orders_view- tai home_kit_orders_manage-käyttöoikeuden.

Pyyntö

Polkuparametrit

string
vaadittu
Sen kotitestipakkaustilauksen yksilöllinen tunniste (UUID), jonka tulokset lähetetään sähköpostitse.

Runkoparametrit

boolean
vaadittu
true liittää laboratorioraportit salasanasuojattuina PDF-tiedostoina. false lähettää vain ilmoituksen siitä, että tulokset ovat valmiit.
string
Henkilökohtainen viesti, joka näytetään sähköpostissa ilmoituksen alla. Enintään 1 000 merkkiä.

Vastaus

Onnistuessaan API palauttaa 200 OK.
string
vaadittu
Osoite, johon sähköposti lähetettiin: profiilin email.
integer
vaadittu
Liitettyjen laboratorioraporttien määrä. 0, kun with_reports on false.
string
vaadittu
Sähköpostin lähetysaika UTC-ajankohtana (ISO 8601 Z-päätteellä).

Virhevastaukset

Virhevastauksen rungossa on ihmisen luettava viesti error ja pysyvä koodi reason. Validointivirheillä ja puuttuvalla results_view-käyttöoikeudella ei ole reason-kenttää.