# Pracownicy

GET /v1/employees

Employee (Pracownik). Pozwala na pobranie danych o pracowniku i skojarzonych z nim dodatkowych informacji takich jak: szkolenia, badania lekarskie, limity urlopowe.

# Definicja obiektu

Definicja obiektu Employee.

# Atrybuty

id int
Unikalny identyfikator pracownika.

registrationNumber string
Numer ewidencyjny pracownika.

interfaceNumber string
Numer interfejsowy pracownika. Wymagane w przypadku dodawania nowego pracownika do systemu.

name string
Imię i nazwisko pracownika. Wymagane w przypadku dodawania nowego pracownika do systemu.

employer string
Kod pracodawcy. Wymagane w przypadku dodawania nowego pracownika do systemu.

location string
Kod lokalizacji. Wymagane w przypadku dodawania nowego pracownika do systemu.

department string
Kod działu. Wymagane w przypadku dodawania nowego pracownika do systemu.

position string
Kod stanowiska. Wymagane w przypadku dodawania nowego pracownika do systemu.

gender string
Płeć.

visaExpireAt date
Data wygaśnięcia wizy o ile podano.

archivedAt datetime
Data i czas archiwizacji pracownika lub null.

tags array[string]
Lista etykiet.

section object
Informacja o przypisanej sekcji pracy pracownika.

id int
Identyfikator sekcji pracy pracownika.

name string
Nazwa sekcji pracy pracownika.

files list
Lista zawiera kartotekę reprezentującą informacje o szkoleniach, badaniach, itp.

type enum
Typ kartoteki. Atrybut wymagany.

trainings - kartoteka szkoleń
medicalExams - kartoteka badań lekarskich

subtype string
Kod rodzaju wpisu dla danego typu kartoteki. Atrybut wymagany.

at date
Data zdarzenia danego typu. Atrybut wymagany.

validTo date
Data ważności. Brak wartości oznacza, że dane wpis jest ważny bezterminowo.

agreements list
Lista umów pracownika.

id int
Identyfikator umowy.

norm decimal
Wymiar czasu pracy (etat).

validFrom date
Data rozpoczęcia obowiązywania umowy.

validTo date
Data zakończenia obowiązywania. Brak wartości oznacza, że umowa jest bezterminowa.

agreementType string
Typ umowy:

contract - umowa zlecenie
agreement - umowa o pracę
agreementWithDefinedPeriod - umowa o pracę na czas określony

worktimeSystem string
System czasu pracy:

basic - podstawowy
balanced - równoważny

isWorktimeFlexible bool
Jeśli true to oznacza, że pracownik ma ruchomy czas pracy.

dailyNorm int
Dzienna norma czasu pracy.

weeklyNorm int
Tygodniowa norma czasu pracy.

parttimerOvertimeType int
Próg nadgodzin pracownika niepełnoetatowego.

parttimerOvertimeThresholdValue int
Wartość progu nadgodzin pracownika niepełnoetatowego

# Przykład

{
    "id": "1",
    "registrationNumber": "xyz123",
    "interfaceNumber": "abc123",
    "name": "Jan Kowalski",
    "employer": "P2P2",
    "location": "WAW",
    "department": "Magazyn",
    "position": "Magazynier",
    "gender": "m",
    "visaExpireAt": "2020-01-01",
    "archivedAt": "2020-01-01T20:00:00",
    "section": {
        "id": "guid",
        "name": "Magazyn",
    },
    "agreements": [
        {
            "id": 0,
            "norm": 1,
            "validFrom": "2020-01-01",
            "agreementType": "agreement",
            "worktimeSystem": "balanced",
            "dailyNorm": 8,
            "weeklyNorm": 40
        },
        { ... }
    ],
    "files": [
        {
            "type": "trainings",
            "subtype": "initial",
            "at": "2020-01-01",
            "validTo": "2020-01-01"
        },
        {
            "type": "medicalExams",
            "subtype": "bhp",
            "at": "2020-01-01",
            "validTo": "2020-01-01"
        },
        { ... }
    ]
}

# Lista obiektów

Zwraca stronicowalną listę pracowników, która domyślnie jest posortowana po dacie utworzenia.

Parametry

limit - ilość rekordów dla strony - domyślnie 10
page - numer strony - domyślnie 1
includes - nazwy pól typu array obiektu Employee, które mają zostać dołączone - domyślnie puste

{
    "url": "/v1/employees",
    "paging": {
        "current": 1,
        "total": 1
    },
    "items": [
        { Employee },
        { ... }
    ]
}

Zwraca
Obiekt zawierający metadane oraz listę pracowników items. Każdy element listy jest osobnym obiektem Employee reprezentującym dane pracownika. Pusta lista oznacza, że nie ma więcej rekordów. To żądanie nigdy nie powinno zwrócić błędu.