Pāriet uz galveno saturu
GET
Skati tavai API atslēgai pieejamo pacientu profilu sarakstu vai meklē konkrētu profilu pēc precīzas e-pasta adreses. Ja ir norādīts email, galapunkts veic Redis kešatmiņā saglabātu precīzas atbilstības meklēšanu pēc kanoniskā pierakstīšanās e-pasta un atgriež 0 vai 1 rezultātu; šajā gadījumā limit un offset tiek ignorēti. Ja tas nav norādīts, galapunkts atgriež pa lapām sadalītu profilu sarakstu tavas API atslēgas piekļuves kontekstā. E-pasta salīdzināšana ir reģistrnejutīga un precīza — apakšvirkņu un prefiksu atbilstības netiek atbalstītas. Tiek pārbaudīts tikai kanoniskais pierakstīšanās e-pasts; alternatīvas adreses, piemēram, work_email, netiek ņemtas vērā. Nepieciešams profiles_view vai impersonate tvērums.

Pieprasījums

Vaicājuma parametri

string
Filtrēt pēc precīzas e-pasta adreses (reģistrnejutīgi). Kad iestatīts, atgriež 0 vai 1 rezultātu un limit/offset tiek ignorēti. Meklēšanu apkalpo Redis kešatmiņā saglabāts apgrieztais indekss ar indeksētu SQL rezerves risinājumu.
integer
noklusējums:"100"
Maksimālais atgriežamo profilu skaits. Noklusējums ir 100, maksimums 500. Tiek ignorēts, ja ir iestatīts email.
integer
noklusējums:"0"
Izlaižamo profilu skaits lapošanai. Noklusējums ir 0. Tiek ignorēts, ja ir iestatīts email.

Atbilde

Veiksmes gadījumā API atgriež 200 OK ar profila objektu masīvu. Katra ieraksta struktūra atbilst Iegūt profilu.
string
obligāts
Unikāls profila identifikators (UUID).
string
Profila segvārds vai lietotājvārds. Var būt null.
string
Vārds. Var būt null.
string
Uzvārds. Var būt null.
string
E-pasta adrese. Var būt null.
string
Tālruņa numurs E.164 formātā. Var būt null.
integer
Bioloģiskais dzimums pēc ISO/IEC 5218 (0 = nezināms, 1 = vīrietis, 2 = sieviete). Var būt null.
string
Dzimšanas datums YYYY-MM-DD formātā. Var būt null.
number
Augums centimetros. Var būt null.
number
Svars kilogramos. Var būt null.
string
Vēlamā valoda: 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 vai uk.
boolean
Vai šis profils saņem transakciju (programmatiskos) e-pastus. null, ja nekad nav iestatīts.
string
Profila izveides laika zīmogs ISO 8601 formātā.
string
Pēdējā atjauninājuma ISO 8601 laikspiedols. Var būt null.

Darbības piezīmes

  • Tukšs masīvs tiek atgriezts gan tad, ja e-pastam neatbilst neviens profils, gan tad, ja atbilstošais profils ir ārpus tava piekļuves konteksta. Tas ir apzināti — tā galapunkts neatklāj tādu profilu esamību, kurus tu nevari lasīt.
  • Jaunizveidotie profili ir uzreiz atrodami pēc email, jo izveides plūsma sinhroni aizpilda kešatmiņu.
  • Nefiltrētais saraksts ir sakārtots dilstošā secībā pēc created_at (jaunākie vispirms) un sadalīts pa lapām ar limit un offset.

Atkārtoti izsaukumi

Aniva saglabā šī galapunkta atbildi 5 minūtes katrai API atslēgai. Atkārtots izsaukums šajā laikā saņem saglabāto atbildi. Galvenes Cache-Status un Age rāda, ka atbilde ir saglabāta un cik veca tā ir. Lai par izmaiņām uzzinātu uzreiz, abonē webhook notikumus profile.created, profile.updated un profile.deleted. Skati Atkārtota lasīšana.

Kļūdu atbildes