Employee

Employee schema

id long? Employee ID - cannot be null in PUT/PATCH methods πŸ“Ά EQUALS,ENUM

_cloudId integer Cloud​

_sellerId long? Seller πŸ“Ά 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

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

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>,
"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
Get employees

https://api.dotykacka.cz/v2/clouds/:cloudId/employees
Request
Response
Request
Path Parameters
cloudId
required
integer
​
Headers
If-None-Match
optional
string
ETag to return results only if changed.
Authorization
required
string
Bearer accessToken
Query Parameters
sort
optional
string
​
filter
optional
string
​
page
optional
integer
​
limit
optional
integer
​
Response
200: OK
[
{
// employee schema
}
]

get
Get employee

https://api.dotykacka.cz/v2/clouds/:cloudId/employees/:employeeId
Request
Response
Request
Path Parameters
employeeId
required
integer
​
cloudId
required
integer
​
Headers
If-None-Match
optional
string
ETag to return results only if changed.
Authorization
required
string
Bearer accessToken
Response
200: OK
{
// employee schema
}

post
Create employee

https://api.dotykacka.cz/v2/clouds/:cloudId/employees
Request
Response
Request
Path Parameters
cloudId
required
integer
​
Headers
Authorization
required
string
Bearer accessToken
Body Parameters
required
array
Array of employee. Maximum size 100.
Response
200: OK
[
{
// employee schema
...
}
]
400: Bad Request
​

put
Replace or create employees

https://api.dotykacka.cz/v2/clouds/:cloudId/employees
Request
Response
Request
Path Parameters
cloudId
required
integer
​
Headers
If-Match
required
string
ETag to update only if not changed.
Authorization
required
string
Bearer accessToken
Body Parameters
required
array
Array of employee. Maximum size 100.
Response
200: OK
[
{
// Employee schema
...
}
]
400: Bad Request
​

put
Replace or create employee

https://api.dotykacka.cz/v2/clouds/:cloudId/employees/:employeeId
Request
Response
Request
Path Parameters
employeeId
required
integer
​
cloudId
required
integer
​
Headers
If-Match
required
string
ETag to update only if not changed.
Authorization
required
string
Bearer accessToken
Body Parameters
required
object
Employee
Response
200: OK
{
// Employee schema
}
400: Bad Request
​

patch
Partial update of employee

https://api.dotykacka.cz/v2/clouds/:cloudId/employees/:employeeId
Request
Response
Request
Path Parameters
employeeId
required
integer
​
cloudId
required
integer
​
Headers
If-Match
required
string
ETag to update only if not changed.
Authorization
required
string
Bearer accessToken
Body Parameters
required
object
Part of employee
Response
200: OK
​
400: Bad Request
​

delete
Delete employee

https://api.dotykacka.cz/v2/clouds/:cloudId/employees/:employeeId
Request
Response
Request
Path Parameters
employeeId
required
integer
​
cloudId
required
integer
​
Headers
If-Match
optional
string
ETag ignored (temporarily) when deleting an entity.
Authorization
required
string
Bearer accessToken
Response
200: OK
​

options
Options employees

https://api.dotykacka.cz/v2/clouds/:cloudId/employees
Request
Response
Request
Path Parameters
cloudId
required
integer
​
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK
​

options
Options employee

https://api.dotykacka.cz/v2/clouds/:cloudId/employees/:employeeId
Request
Response
Request
Path Parameters
employeeId
required
integer
​
cloudId
required
integer
​
Headers
Authorization
required
string
Bearer accessToken
Response
200: OK
​

Set access pin schema

accessPin string(4,...) Numeric characters only

requirePinAlways boolean?

JSON access pin schema

{
"accessPin": <string>,
"requirePinAlways": <boolean>
}

post
Set employee access pin

https://api.dotykacka.cz/v2/clouds/:cloudId/employees/:employeeId/access-pins
Request
Response
Request
Path Parameters
employeeId
required
integer
​
cloudId
required
integer
​
Headers
Authorization
required
string
Bearer accessToken
Body Parameters
required
object
Access pin schema
Response
200: OK
​