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
| Parametr | Typ | Povinný | Výchozí | Popis |
|---|---|---|---|---|
page | int | ne | 1 | Číslo stránky |
pageSize | int | ne | 25 | Počet záznamů na stránku (max. 100) |
Odpověď
| Pole | Typ | Popis |
|---|---|---|
Page | int | Aktuální stránka |
PageSize | int | Počet záznamů na stránku |
Results[].IdClient | uuid | Identifikátor klienta |
Results[].FullName | string | Celé jméno klienta |
Results[].PersonalId | string | Rodné číslo nebo jiný identifikátor |
Results[].Phone | string | Telefon |
Results[].Email | string |
GET /api/v1/Client/Extended
Vrátí stránkovaný seznam klientů s rozšířenými informacemi a podporou filtrování.
Parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
page | int | ne | Číslo stránky (výchozí 1) |
pageSize | int | ne | Počet záznamů na stránku, max. 100 (výchozí 25) |
active | bool | ne | Filtr dle aktivity klienta (true = aktivní, false = neaktivní) |
filter | string | ne | Fulltextové vyhledávání (jméno, e-mail, telefon apod.) |
idStaff | uuid | ne | Filtr dle přiřazeného zaměstnance |
idLocation | uuid | ne | Filtr 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
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
idClient | uuid | ano | Identifikátor klienta |
Odpověď
| Sekce | Popis |
|---|---|
PersonalInfo | Osobní údaje (jméno, rodné číslo, datum narození, pohlaví) |
ContactInfo | Kontaktní a adresní údaje |
Staff | Přiřazený lékař |
Location | Pobočka klienta |
Insurance | Zdravotní pojišťovna |
Medical | Alergie a léky |
Status | Stav klienta (aktivní / neaktivní) |
Chybové stavy
| Status | Kód | Popis |
|---|---|---|
404 | CLIENT_NOT_FOUND | Klient s daným idClient neexistuje |