Employee

Please see the Breaking changes page for more info on the planned changes in validation.

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 employees

GET https://api.dotykacka.cz/v2/clouds/:cloudId/employees

Path Parameters

NameTypeDescription

cloudId*

integer

Query Parameters

NameTypeDescription

sort

string

filter

string

page

integer

limit

integer

Headers

NameTypeDescription

If-None-Match

string

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

[
 {
  // employee schema
 }
]

Get employee

GET https://api.dotykacka.cz/v2/clouds/:cloudId/employees/:employeeId

Path Parameters

NameTypeDescription

employeeId*

integer

cloudId*

integer

Headers

NameTypeDescription

If-None-Match

string

ETag to return results only if changed.

Authorization*

string

Bearer accessToken

{
    // employee schema
}

Create employee

POST https://api.dotykacka.cz/v2/clouds/:cloudId/employees

Path Parameters

NameTypeDescription

cloudId*

integer

Headers

NameTypeDescription

Authorization*

string

Bearer accessToken

Request Body

NameTypeDescription

array

Array of employee. Maximum size 100.

[
    {
        // employee schema
        ...
    }
]

Replace or create employees

PUT https://api.dotykacka.cz/v2/clouds/:cloudId/employees

Path Parameters

NameTypeDescription

cloudId*

integer

Headers

NameTypeDescription

If-Match

string

ETag to update only if not changed.

Authorization*

string

Bearer accessToken

Request Body

NameTypeDescription

array

Array of employee. Maximum size 100.

[
    {
        // Employee schema
        ...
    }
]

Replace or create employee

PUT https://api.dotykacka.cz/v2/clouds/:cloudId/employees/:employeeId

Path Parameters

NameTypeDescription

employeeId*

integer

cloudId*

integer

Headers

NameTypeDescription

If-Match

string

ETag to update only if not changed.

Authorization*

string

Bearer accessToken

Request Body

NameTypeDescription

object

Employee

{
    // Employee schema
}

Partial update of employee

PATCH https://api.dotykacka.cz/v2/clouds/:cloudId/employees/:employeeId

Path Parameters

NameTypeDescription

employeeId*

integer

cloudId*

integer

Headers

NameTypeDescription

If-Match*

string

ETag to update only if not changed.

Authorization*

string

Bearer accessToken

Request Body

NameTypeDescription

object

Part of employee

Delete employee

DELETE https://api.dotykacka.cz/v2/clouds/:cloudId/employees/:employeeId

Path Parameters

NameTypeDescription

employeeId*

integer

cloudId*

integer

Headers

NameTypeDescription

If-Match

string

ETag ignored (temporarily) when deleting an entity.

Authorization*

string

Bearer accessToken

Options employees

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/employees

Path Parameters

NameTypeDescription

cloudId*

integer

Headers

NameTypeDescription

Authorization*

string

Bearer accessToken

Options employee

OPTIONS https://api.dotykacka.cz/v2/clouds/:cloudId/employees/:employeeId

Path Parameters

NameTypeDescription

employeeId*

integer

cloudId*

integer

Headers

NameTypeDescription

Authorization*

string

Bearer accessToken

Set access pin schema

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

requirePinAlways boolean?

JSON access pin schema

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

Set employee access pin

POST https://api.dotykacka.cz/v2/clouds/:cloudId/employees/:employeeId/access-pins

Path Parameters

NameTypeDescription

employeeId*

integer

cloudId*

integer

Headers

NameTypeDescription

Authorization*

string

Bearer accessToken

Request Body

NameTypeDescription

object

Access pin schema

Last updated