Ugrás a fő tartalomhoz
GET
Listázd az API-kulcsod számára elérhető páciensprofilokat, vagy keress meg egyet pontos e-mail-cím alapján. Ha megadod az email paramétert, a végpont Redis-gyorsítótárazott, pontos egyezésű keresést végez a kanonikus bejelentkezési e-mail-címen, és 0 vagy 1 találatot ad vissza; ebben az esetben a limit és az offset figyelmen kívül marad. Ha elhagyod, a végpont az API-kulcsod hozzáférési körébe tartozó profilok lapozott listáját adja vissza. Az e-mail-egyeztetés nem különbözteti meg a kis- és nagybetűket, és pontos — a részszöveges és előtagos egyezést nem támogatja. Csak a kanonikus bejelentkezési e-mail-címet ellenőrzi; az alternatív címeket, például a work_email mezőt nem veszi figyelembe. A profiles_view vagy az impersonate scope szükséges hozzá.

Kérés

Lekérdezési paraméterek

string
Szűrés pontos e-mail-cím alapján (kis- és nagybetűre nem érzékeny). Megadásakor 0 vagy 1 találatot ad vissza, és a limit/offset figyelmen kívül marad. A keresést egy Redis-gyorsítótárazott fordított index szolgálja ki, indexelt SQL tartalékmegoldással.
integer
alapértelmezett:"100"
A visszaadható profilok maximális száma. Alapértelmezett értéke 100, maximuma 500. Ha az email meg van adva, figyelmen kívül marad.
integer
alapértelmezett:"0"
A lapozáshoz átugrandó profilok száma. Alapértelmezett értéke 0. Ha az email meg van adva, figyelmen kívül marad.

Válasz

Siker esetén az API 200 OK választ ad vissza profilobjektumok tömbjével. Minden elem struktúrája megegyezik a Profil lekérése végpontéval.
string
kötelező
Egyedi profilazonosító (UUID).
string
Profil handle vagy felhasználónév. Lehet null.
string
Keresztnév. Lehet null.
string
Vezetéknév. Lehet null.
string
E-mail-cím. Lehet null.
string
Telefonszám E.164 formátumban. Lehet null.
integer
Biológiai nem az ISO/IEC 5218 szerint (0 = ismeretlen, 1 = férfi, 2 = nő). Lehet null.
string
Születési dátum YYYY-MM-DD formátumban. Lehet null.
number
Magasság centiméterben. Lehet null.
number
Testsúly kilogrammban. Lehet null.
string
Preferált nyelv: 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 vagy uk.
boolean
Kap-e ez a profil tranzakciós (automatikus) e-maileket. null, ha még soha nem állították be.
string
A profil létrehozásának ISO 8601 időbélyege.
string
Az utolsó frissítés ISO 8601 időbélyege. Lehet null.

Működési megjegyzések

  • Üres tömböt kapsz vissza akkor is, ha egyetlen profil sem egyezik az e-mail-címmel, és akkor is, ha van találat a hozzáférési körödön kívül. Ez szándékos — így a végpont nem szivárogtatja ki olyan profilok létezését, amelyeket nem olvashatsz.
  • Az újonnan létrehozott profilok azonnal megtalálhatók email alapján, mert a létrehozási folyamat szinkron módon feltölti a gyorsítótárat.
  • A szűretlen lista created_at szerint csökkenő sorrendű (legújabb elöl), és a limit és offset segítségével lapozható.

Ismételt hívások

Az Aniva minden API-kulcshoz 5 percig tárolja ennek a végpontnak a válaszát. Ezen az időn belül egy ismételt hívás a tárolt választ kapja vissza. A Cache-Status és az Age fejléc mutatja, hogy a válasz tárolt, és mennyi idős. Ha azonnal értesülni szeretnél a változásokról, iratkozz fel a profile.created, profile.updated és profile.deleted webhook-eseményekre. Lásd: Ismételt olvasások.

Hibaválaszok