Siirry pääsisältöön
GET
Listaa API-avaimesi käytettävissä olevat potilasprofiilit tai hae yksittäinen profiili tarkalla sähköpostiosoitteella. Kun email annetaan, päätepiste tekee Redis-välimuistitetun tarkan haun varsinaisesta kirjautumissähköpostiosoitteesta ja palauttaa 0 tai 1 tulosta; limit- ja offset-parametrit ohitetaan tällöin. Kun se jätetään pois, päätepiste palauttaa sivutetun listan profiileista API-avaimesi käyttöoikeusalueen mukaan rajattuna. Sähköpostin täsmäys on kirjainkoosta riippumaton ja tarkka — osamerkkijono- ja etuliitehakuja ei tueta. Vain varsinainen kirjautumissähköpostiosoite tarkistetaan; vaihtoehtoisia osoitteita, kuten work_email, ei huomioida. Vaatii profiles_view- tai impersonate-käyttöoikeuden.

Pyyntö

Kyselyparametrit

string
Suodata tarkan sähköpostiosoitteen mukaan (kirjainkoosta riippumaton). Kun arvo on asetettu, palauttaa 0 tai 1 tulosta ja limit/offset ohitetaan. Haku palvellaan Redis-välimuistitetusta käänteisindeksistä, ja varajärjestelmänä toimii indeksoitu SQL-haku.
integer
oletus:"100"
Palautettavien profiilien enimmäismäärä. Oletus on 100, enimmäismäärä 500. Ohitetaan, kun email on asetettu.
integer
oletus:"0"
Sivutusta varten ohitettavien profiilien määrä. Oletus on 0. Ohitetaan, kun email on asetettu.

Vastaus

Onnistuessaan API palauttaa tilan 200 OK ja taulukon profiiliobjekteja. Kunkin alkion rakenne vastaa Hae profiili -päätepistettä.
string
vaadittu
Profiilin yksilöllinen tunniste (UUID).
string
Profiilin nimimerkki tai käyttäjätunnus. Voi olla null.
string
Etunimi. Voi olla null.
string
Sukunimi. Voi olla null.
string
Sähköpostiosoite. Voi olla null.
string
Puhelinnumero E.164-muodossa. Voi olla null.
integer
Biologinen sukupuoli ISO/IEC 5218 -standardin mukaan (0 = tuntematon, 1 = mies, 2 = nainen). Voi olla null.
string
Syntymäaika YYYY-MM-DD-muodossa. Voi olla null.
number
Pituus senttimetreinä. Voi olla null.
number
Paino kilogrammoina. Voi olla null.
string
Ensisijainen kieli: en, bg, ca, cs, da, de, el, es, et, fi, fr, ga, hr, hu, is, it, lb, lt, lv, mt, nl, no, pl, pt, ro, ru, sk, sl, sr, sv, tr tai uk.
boolean
Vastaanottaako profiili tapahtumapohjaisia (ohjelmallisia) sähköposteja. null, jos arvoa ei ole koskaan asetettu.
string
ISO 8601 -aikaleima profiilin luontihetkestä.
string
ISO 8601 -aikaleima viimeisimmästä päivityksestä. Voi olla null.

Huomioita toiminnasta

  • Tyhjä taulukko palautetaan sekä silloin, kun yksikään profiili ei vastaa sähköpostia, että silloin, kun osuma on käyttöoikeusalueesi ulkopuolella. Tämä on tarkoituksellista — se estää päätepistettä paljastamasta sellaisten profiilien olemassaoloa, joita et voi lukea.
  • Vasta luodut profiilit ovat heti haettavissa email-osoitteella, koska luontiprosessi päivittää välimuistin synkronisesti.
  • Suodattamaton lista on järjestetty created_at-kentän mukaan laskevasti (uusin ensin) ja sivutettu limit- ja offset-parametreilla.

Toistuvat kutsut

Aniva tallentaa tämän päätepisteen vastauksen 5 minuutiksi kullekin API-avaimelle. Tämän ajan sisällä tehty toistuva kutsu saa tallennetun vastauksen. Otsikot Cache-Status ja Age kertovat, että vastaus on tallennettu ja kuinka vanha se on. Saat tiedon muutoksista heti tilaamalla webhook-tapahtumat profile.created, profile.updated ja profile.deleted. Katso Toistuvat lukupyynnöt.

Virhevastaukset