Klienti
Endpointy pro přístup ke klientským datům.
Seznam klientů
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 | ClientItem[] | Seznam klientů |
ClientItem
| Pole | Typ | Popis |
|---|---|---|
IdClient | uuid | Identifikátor klienta |
FullName | string | Celé jméno klienta |
PersonalId | string | Rodné číslo nebo jiný identifikátor |
Phone | string | Telefon |
Email | string |
Rozšířený seznam klientů
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í). Při vynechání je výchozí true. |
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ěď
| Pole | Typ | Popis |
|---|---|---|
Page | int | Aktuální stránka |
PageSize | int | Počet záznamů na stránku |
Results | ClientItem[] | Seznam klientů |
ClientItem
| Pole | Typ | Popis |
|---|---|---|
IdClient | uuid | Identifikátor klienta |
FullName | string | Celé jméno klienta |
Active | bool | Zda je klient aktivní |
PersonalInfo | ClientPersonalInfo | Osobní údaje klienta |
ContactInfo | ClientContactInfo | Kontaktní údaje klienta |
ClientPersonalInfo
| Pole | Typ | Popis |
|---|---|---|
Firstname | string | Jméno |
Lastname | string | Příjmení |
Education | string | Titul před |
EducationAfter | string | Titul za |
PersonalId | string | Rodné číslo nebo jiný identifikátor |
DateOfBirth | datetime | Datum narození |
ClientContactInfo
| Pole | Typ | Popis |
|---|---|---|
Phone | string | Telefon |
Email | string | |
Street | string | Ulice |
City | string | Město |
Post | string | PSČ |
Detail klienta
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í) |
Tags | Štítky klienta |
Objednávky klienta
GET /api/v1/Client/{idClient}/Appointments
Vrátí poslední proběhlé a nejbližší budoucí objednávky klienta.
Dostupnost
Objednávky klienta jsou dostupné pouze pro tarify Business a Enterprise.
Path parametry
| Parametr | Typ | Povinný | Popis |
|---|---|---|---|
idClient | uuid | ano | Identifikátor klienta |
Query parametry
| Parametr | Typ | Povinný | Výchozí | Popis |
|---|---|---|---|---|
PreviousLimit | int | ne | 10 | Počet předchozích objednávek, max. 50 |
FutureLimit | int | ne | 10 | Počet budoucích objednávek, max. 50 |
Odpověď
| Pole | Typ | Popis |
|---|---|---|
PreviousAppointments | AppointmentItem[] | Předchozí objednávky |
FutureAppointments | AppointmentItem[] | Budoucí objednávky |
AppointmentItem
| Pole | Typ | Popis |
|---|---|---|
Appointment | AppointmentInfo | Informace o objednávce |
Client | AppointmentClient | Informace o klientovi |
Staff | AppointmentStaff | Informace o zaměstnanci |
Service | AppointmentService | Informace o službě |
AppointmentInfo
| Pole | Typ | Popis |
|---|---|---|
IdAppointment | uuid | Identifikátor objednávky |
StartDate | datetime | Začátek objednávky |
EndDate | datetime | Konec objednávky |
Description | string | Popis objednávky |
Status | string | Stav objednávky |
OnlineBooked | bool | Objednáno online |
Confirmed | bool | Potvrzená objednávka |
AppointmentClient
| Pole | Typ | Popis |
|---|---|---|
IdClient | uuid | Identifikátor klienta |
ClientName | string | Jméno klienta z objednávky |
AppointmentStaff
| Pole | Typ | Popis |
|---|---|---|
IdStaff | uuid | Identifikátor zaměstnance |
StaffName | string | Jméno zaměstnance |
AppointmentService
| Pole | Typ | Popis |
|---|---|---|
IdService | uuid | Identifikátor služby |
ServiceCaption | string | Název služby |
Chybové stavy
| Status | Kód | Popis |
|---|---|---|
404 | CLIENT_NOT_FOUND | Klient s daným idClient neexistuje |