API
Search…
⌃K

Employee

Employee schema

id long? Employee ID - cannot be null in PUT/PATCH methods 📶 EQUALS,ENUM
_cloudId integer Cloud ID
_sellerId long? Seller ID 📶 EQUALS,ENUM
accessLevel long Access level 📶 BITS
barcode string?(180) Bar code 📶 STRING
deleted boolean Employee deleted - cannot be true in POST/PUT/PATCH methods 📶 EQUALS, ENUM 🔽 BOTH
email string?(100) E-mail address 📶 STRING 🔽 BOTH
enabled boolean Employee enabled 📶 EQUALS, ENUM
hexColor string(7) Employee color
maxDiscount double? Max discount
modifiedBy string?(32) Employee modified by
name string(256) Employee name - must not be empty 📶 STRING 🔽 BOTH
phone string?(40) Phone number 📶 STRING
requirePinAlways boolean Whether the PIN is always required 📶 EQUALS, ENUM
stockAccessLevel long Stock access level 📶 BITS
tags string[]? Tags list for employee 📶 EQUALS, ENUM
versionDate timestamp? Last modification date and time 📶 EQUALS, ENUM, NUMBER 🔽 BOTH

JSON response

{
"_cloudId": <integer>,
"_sellerId": <long>,
"accessLevel": <long>,
"barcode": <string>,
"deleted": <boolean>,
"email": <string>,
"enabled": <boolean>,
"hexColor": <string>,
"id": <long> ,
"maxDiscount": <double>,
"modifiedBy": <string>,
"name": <string>,
"phone": <string>,
"requirePinAlways": <boolean>,
"stockAccessLevel": <long>,
"tags": <string[]>,
"versionDate": <timestamp>
}
get
https://api.dotykacka.cz
/v2/clouds/:cloudId/employees
Get employees
get
https://api.dotykacka.cz
/v2/clouds/:cloudId/employees/:employeeId
Get employee
post
https://api.dotykacka.cz
/v2/clouds/:cloudId/employees
Create employee
put
https://api.dotykacka.cz
/v2/clouds/:cloudId/employees
Replace or create employees
put
https://api.dotykacka.cz
/v2/clouds/:cloudId/employees/:employeeId
Replace or create employee
patch
https://api.dotykacka.cz
/v2/clouds/:cloudId/employees/:employeeId
Partial update of employee
delete
https://api.dotykacka.cz
/v2/clouds/:cloudId/employees/:employeeId
Delete employee
options
https://api.dotykacka.cz
/v2/clouds/:cloudId/employees
Options employees
options
https://api.dotykacka.cz
/v2/clouds/:cloudId/employees/:employeeId
Options employee

Set access pin schema

accessPin string(4,...) Numeric characters only
requirePinAlways boolean?

JSON access pin schema

{
"accessPin": <string>,
"requirePinAlways": <boolean>
}
post
https://api.dotykacka.cz
/v2/clouds/:cloudId/employees/:employeeId/access-pins
Set employee access pin