Hopp til hovedinnhold
GET
List opp pasientprofiler som API-nøkkelen din har tilgang til, eller slå opp én etter eksakt e-postadresse. Når email oppgis, gjør endepunktet et Redis-bufret eksakt oppslag mot den kanoniske innloggings-e-postadressen og returnerer 0 eller 1 treff; limit og offset ignoreres i så fall. Når parameteren utelates, returnerer endepunktet en paginert liste over profiler avgrenset til tilgangskonteksten til API-nøkkelen din. Samsvar på e-post skiller ikke mellom store og små bokstaver og må være eksakt – delstreng- og prefikstreff støttes ikke. Kun den kanoniske innloggings-e-postadressen sjekkes; alternative adresser som work_email blir ikke vurdert. Krever tilgangsomfanget profiles_view eller impersonate.

Forespørsel

Spørreparametere

string
Filtrer etter eksakt e-postadresse (skiller ikke mellom store og små bokstaver). Når den er angitt, returneres 0 eller 1 treff, og limit/offset ignoreres. Oppslaget betjenes av en Redis-bufret omvendt indeks, med indeksert SQL som reserveløsning.
integer
standard:"100"
Maksimalt antall profiler som returneres. Standard er 100, maks 500. Ignoreres når email er angitt.
integer
standard:"0"
Antall profiler som skal hoppes over ved paginering. Standard er 0. Ignoreres når email er angitt.

Respons

Ved suksess returnerer API-et 200 OK med en liste med profilobjekter. Strukturen til hvert element samsvarer med Hent profil.
string
påkrevd
Unik profilidentifikator (UUID).
string
Profilnavn eller brukernavn. Kan være null.
string
Fornavn. Kan være null.
string
Etternavn. Kan være null.
string
E-postadresse. Kan være null.
string
Telefonnummer i E.164-format. Kan være null.
integer
Biologisk kjønn etter ISO/IEC 5218 (0 = ukjent, 1 = mann, 2 = kvinne). Kan være null.
string
Fødselsdato i formatet YYYY-MM-DD. Kan være null.
number
Høyde i centimeter. Kan være null.
number
Vekt i kilogram. Kan være null.
string
Foretrukket språk: 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 eller uk.
boolean
Om denne profilen mottar transaksjonelle (programmatiske) e-poster. null når verdien aldri er satt.
string
ISO 8601-tidsstempel for når profilen ble opprettet.
string
ISO 8601-tidsstempel for siste oppdatering. Kan være null.

Merknader om virkemåte

  • En tom liste returneres både når ingen profil samsvarer med e-postadressen, og når et treff finnes utenfor tilgangskonteksten din. Dette er tilsiktet – det hindrer endepunktet i å lekke eksistensen av profiler du ikke har lesetilgang til.
  • Nyopprettede profiler kan umiddelbart finnes via email fordi opprettelsesflyten varmer opp hurtigbufferen synkront.
  • Den ufiltrerte listen sorteres etter created_at synkende (nyeste først) og pagineres med limit og offset.

Gjentatte kall

Aniva lagrer svaret fra dette endepunktet i 5 minutter for hver API-nøkkel. Et gjentatt kall innenfor denne tiden får det lagrede svaret. Headerne Cache-Status og Age viser at svaret er lagret og hvor gammelt det er. For å få beskjed om en endring med en gang kan du abonnere på webhook-hendelsene profile.created, profile.updated og profile.deleted. Se Gjentatte lesinger.

Feilresponser