#
Harmonogramy
GET /v2/employeeschedules
EmployeeSchedule (Harmonogram). Pozwala na pobranie zdefiniowanych harmonorgamów pracy pracowników.
#
Definicja obiektu
Definicja obiektu EmployeeSchedule.
#
Atrybuty
id int
Unikalny identyfikator dla tego obiektu.
employeeId string
Numer interfejsowy pracownika.
employeeUniqueId int
Unikalny identyfikator pracownika.
day date
Dzień pracy na który obowiązuje harmonogram.
from datetime
Data i czas planowanego rozpoczęcia pracy.
to datetime
Data i czas planowanego zakończenia pracy.
duration duration
Czas trwania planowanej pracy.
earlier int
Dozwolona ilość godzin wcześniejszego rozpoczęcia pracy.
fromEarlier datetime
Data i czas planowanego rozpoczęcia pracy z uwzględnieniem wcześniejszego przyjścia.
modifiedAt datetime
Data i czas ostatniej modyfikacji
#
Przykład
{
"id": 1,
"employeeId": "abc123",
"employeeUniqueId": 123,
"day": "2020-01-01",
"from": "2020-01-01T06:00:00",
"to": "2020-01-01T14:00:00",
"duration": "08:00:00",
"earlier": 0,
"fromEarlier": "2020-01-01T06:00:00",
"modifiedAt": "2020-02-01T00:00:00"
}
#
Lista obiektów
Zwraca stronicowalną listę harmonogramów pracowników.
Parametry
- limit - ilość rekordów dla strony - domyślnie 1000
- page - numer strony - domyślnie 1
- from - filtr bazujący na dacie harmonogramu, podanie tej daty spowoduje, że zwrócone zostaną tylko te które będą starsze bądź równe podanej wartości - domyślnie dzień bieżący
- to - filtr bazujący na dacie harmonogramu, podanie tej daty spowoduje, że zwrócone zostaną tylko te które będą nowsze bądź równe podanej wartości - domyślnie dzień bieżący
- employee - podany id pracownika spowoduje, że zwrócone zostaną harmonogramy tylko jednego pracownika - domyślnie puste
- location - podany id lokalizacji spowoduje, że zwrócone zostaną harmonogramy pracowników ze wskazanej lokalizacji - domyślnie puste
- employer - podany id pracodawcy spowoduje, że zwrócone zostaną harmonogramy pracowników dla wskazanego pracodawcy - domyślnie puste
- withArchivedEmployees - dla wartości
1dodatkowo zostaną zwrócone dane także dla pracowników archiwalnych - domyślnie puste
{
"paging": {
"current": 1,
"total": 1
},
"items": [
{ EmployeeSchedule },
{ ... }
]
}
Zwraca
Obiekt zawierający metadane oraz listę harmonogramów items. Każdy element listy jest osobnym obiektem EmployeeSchedule. Pusta lista oznacza, że nie ma więcej rekordów. To żądanie nigdy nie powinno zwrócić błędu.