API/attendanceIntervalsBulk POST
Dosys 5.1.3.17
POST [url docházky]?doc=api/attendanceIntervalsBulk
Přehled
Endpoint slouží pro hromadné vytvoření intervalů docházky.
Oprávnění
Pro volání endpointu je vyžadováno oprávnění pro zápis do API api/attendance/intervals.
Zpracování
Data intervalů se předávají jako tělo zprávy POST ve formátu JSON pole objektů. Každá položka pole reprezentuje jeden interval docházky.
| Údaj | Typ | Povinné | Popis |
|---|---|---|---|
| Employee | string | Identifikátor zaměstnance. Musí být zadán právě jeden z údajů Employee a EmployeeNumber. | |
| EmployeeNumber | string | Osobní číslo zaměstnance. Musí být zadán právě jeden z údajů Employee a EmployeeNumber. | |
| PassType | string | • | Typ průchodu. Prázdný řetězec znamená pracovní dobu. |
| Date | date | • | Datum záznamu ve formátu YYYY-MM-DD. |
| TimeFrom | ?time | Nepovinný začátek práce v sekundách. | |
| TimeTo | ?time | Nepovinný konec práce v sekundách. Lze zadat pouze tehdy, je-li zadáno TimeFrom, a zároveň nesmí být zadán údaj Length. | |
| Length | ?time | Nepovinná délka práce v sekundách. Lze zadat pouze tehdy, je-li zadáno TimeFrom, a zároveň nesmí být zadán údaj TimeTo. |
Validační pravidla
- Musí být zadán právě jeden z údajů Employee a EmployeeNumber.
- Pokud je zadán údaj TimeFrom, musí být zadán právě jeden z údajů TimeTo a Length.
- Pokud zaměstnanec podle zadaného identifikátoru neexistuje, položka je vrácena mezi chybami.
- Pokud se pro danou položku nepodaří vygenerovat žádný interval, položka je přeskočena a vrácena mezi chybami.
Odpověď
Při úspěšném zpracování endpoint vrací HTTP kód 201 a JSON objekt s výsledkem zpracování.
| Údaj | Typ | Popis |
|---|---|---|
| Total | int | Celkový počet položek v požadavku. |
| Processed | int | Počet úspěšně zpracovaných položek. |
| Errors | array | Seznam chyb pro nezpracované položky. |
Položka Errors
| Údaj | Typ | Popis |
|---|---|---|
| Index | int | Index chybné položky v rámci vstupního pole, číslováno od 0. |
| Message | string | Text chyby. |
Chybová odpověď
Při chybě zpracování celého požadavku endpoint vrací HTTP kód 400 a JSON objekt:
| Údaj | Typ | Popis |
|---|---|---|
| Message | string | Popis chyby. |
Při nedostatečném oprávnění endpoint vrací HTTP kód 403.
Příklad požadavku
[
{
"Employee": "NOVAK",
"PassType": "",
"Date": "2026-03-27",
"TimeFrom": 28800,
"Length": 28800
},
{
"EmployeeNumber": "1234",
"PassType": "VAC",
"Date": "2026-03-27"
}
]
Příklad úspěšné odpovědi
{
"Total": 2,
"Processed": 1,
"Errors": [
{
"Index": 1,
"Message": "Employee not found."
}
]
}