Skip to content

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 ​

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
ResultsClientItem[]Seznam klientů

ClientItem ​

PoleTypPopis
IdClientuuidIdentifikátor klienta
FullNamestringCelé jméno klienta
PersonalIdstringRodné číslo nebo jiný identifikátor
PhonestringTelefon
EmailstringE-mail

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 ​

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í). Při vynechání je výchozí true.
FilterstringneFulltextové vyhledávání (jméno, e-mail, telefon apod.)
IdStaffuuidneFiltr dle přiřazeného zaměstnance
IdLocationuuidneFiltr dle pobočky

Odpověď ​

PoleTypPopis
PageintAktuální stránka
PageSizeintPočet záznamů na stránku
ResultsClientItem[]Seznam klientů

ClientItem ​

PoleTypPopis
IdClientuuidIdentifikátor klienta
FullNamestringCelé jméno klienta
ActiveboolZda je klient aktivní
PersonalInfoClientPersonalInfoOsobní údaje klienta
ContactInfoClientContactInfoKontaktní údaje klienta

ClientPersonalInfo ​

PoleTypPopis
FirstnamestringJméno
LastnamestringPříjmení
EducationstringTitul před
EducationAfterstringTitul za
PersonalIdstringRodné číslo nebo jiný identifikátor
DateOfBirthdatetimeDatum narození

ClientContactInfo ​

PoleTypPopis
PhonestringTelefon
EmailstringE-mail
StreetstringUlice
CitystringMěsto
PoststringPSČ

Detail klienta ​

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í)
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 ​

ParametrTypPovinnýPopis
idClientuuidanoIdentifikátor klienta

Query parametry ​

ParametrTypPovinnýVýchozíPopis
PreviousLimitintne10Počet předchozích objednávek, max. 50
FutureLimitintne10Počet budoucích objednávek, max. 50

Odpověď ​

PoleTypPopis
PreviousAppointmentsAppointmentItem[]Předchozí objednávky
FutureAppointmentsAppointmentItem[]Budoucí objednávky

AppointmentItem ​

PoleTypPopis
AppointmentAppointmentInfoInformace o objednávce
ClientAppointmentClientInformace o klientovi
StaffAppointmentStaffInformace o zaměstnanci
ServiceAppointmentServiceInformace o službě

AppointmentInfo ​

PoleTypPopis
IdAppointmentuuidIdentifikátor objednávky
StartDatedatetimeZačátek objednávky
EndDatedatetimeKonec objednávky
DescriptionstringPopis objednávky
StatusstringStav objednávky
OnlineBookedboolObjednáno online
ConfirmedboolPotvrzená objednávka

AppointmentClient ​

PoleTypPopis
IdClientuuidIdentifikátor klienta
ClientNamestringJméno klienta z objednávky

AppointmentStaff ​

PoleTypPopis
IdStaffuuidIdentifikátor zaměstnance
StaffNamestringJméno zaměstnance

AppointmentService ​

PoleTypPopis
IdServiceuuidIdentifikátor služby
ServiceCaptionstringNázev služby

Chybové stavy ​

StatusKódPopis
404CLIENT_NOT_FOUNDKlient s daným idClient neexistuje