Skip to content

Klienti

Endpointy pro přístup ke klientským datům. K dispozici jsou tři úrovně detailu: zjednodušený seznam, rozšířený seznam s filtrováním a detail klienta.

GET /api/v1/Client/Simple

Vrátí stránkovaný seznam klientů se základními informacemi.

Parametry

ParametrTypPovinnýVýchozíPopis
pageintne1Číslo stránky
pageSizeintne25Počet záznamů na stránku (max. 100)

Odpověď

PoleTypPopis
PageintAktuální stránka
PageSizeintPočet záznamů na stránku
Results[].IdClientuuidIdentifikátor klienta
Results[].FullNamestringCelé jméno klienta
Results[].PersonalIdstringRodné číslo nebo jiný identifikátor
Results[].PhonestringTelefon
Results[].EmailstringE-mail

GET /api/v1/Client/Extended

Vrátí stránkovaný seznam klientů s rozšířenými informacemi a podporou filtrování.

Parametry

ParametrTypPovinnýPopis
pageintneČíslo stránky (výchozí 1)
pageSizeintnePočet záznamů na stránku, max. 100 (výchozí 25)
activeboolneFiltr dle aktivity klienta (true = aktivní, false = neaktivní)
filterstringneFulltextové vyhledávání (jméno, e-mail, telefon apod.)
idStaffuuidneFiltr dle přiřazeného zaměstnance
idLocationuuidneFiltr dle pobočky

Odpověď

Response má stejný obal jako /Client/Simple (Page, PageSize, Results[])

Kromě základních polí obsahuje i další údaje o klientovi, zejména vnořené objekty:

  • PersonalInfo (osobní údaje)
  • ContactInfo (kontaktní údaje)

GET /api/v1/Client/Detail/{idClient}

Vrátí detail konkrétního klienta.

Path parametry

ParametrTypPovinnýPopis
idClientuuidanoIdentifikátor klienta

Odpověď

SekcePopis
PersonalInfoOsobní údaje (jméno, rodné číslo, datum narození, pohlaví)
ContactInfoKontaktní a adresní údaje
StaffPřiřazený lékař
LocationPobočka klienta
InsuranceZdravotní pojišťovna
MedicalAlergie a léky
StatusStav klienta (aktivní / neaktivní)

Chybové stavy

StatusKódPopis
404CLIENT_NOT_FOUNDKlient s daným idClient neexistuje