Співробітники

В даному розділі наведено повний опис доступних можливостей API для роботи зі співробітниками. Спочатку ознайомтесь з параметрами, які використовує Syrve. Розуміння їх значення буде корисним для вас у майбутньому при редагуванні та створенні нових співробітників.

Опис параметрів

id (string): Унікальний ідентифікатор.
code (string): Код в системі.
name (string): Ім'я в системі.
login (string): Логін для входу в бекофіс.
password (string): Пароль для входу в бекофіс.
pinCode (string): Пін-код для входу в iikoFront.
mainRoleCode (string): Код головної ролі співробітника.
roleCodes (string): Список кодів ролей співробітника.
phone (string): Телефон.
cellPhone (string): Мобільний телефон.
firstName (string): Ім'я.
middleName (string): По батькові.
lastName (string): Прізвище.
birthday (dateTime): Дата народження (yyyy-MM-dd'T'HH:mm).
email (string): Електронна пошта.
address (string): Адреса проживання.
hireDate (string): Дата прийняття на роботу.
fireDate (dateTime): Дата звільнення (yyyy-MM-dd'T'HH:mm).
preferredDepartmentCode (string): Код переважного відділу співробітника.
departmentCodes (string): Список кодів відділів, до яких належить співробітник.
responsibilityDepartmentCodes (string): Список кодів відділів, за якими співробітник несе відповідальність.
deleted (string): Позначка, що співробітник видалений.
supplier (string): Інформація про те, чи є співробітник постачальником.
employee (string): Інформація про те, чи є співробітник працівником.
client (string): Інформація про те, чи є співробітник клієнтом.

Список співробітників

Метод list() дозволяє отримати список співробітників з системи Syrve. При використанні цього методу, ви можете вказати додатковий параметр deleted, який приймає значення true або false.

Параметри:

deleted (опціональний): Визначає, чи включати видалених співробітників у список.
- true: Список включатиме і видалених співробітників.
- false: Список не буде містити видалених співробітників (за замовчуванням).

Приклад використання:

// Отримати список всіх співробітників (без видалених)
$response = $syrve->employees->list();

// Отримати список співробітників, включаючи видалених
$response = $syrve->employees->list(true);

Список по підрозділу

Метод department() дозволяє отримати список співробітників за певним підрозділом у системі Syrve. При використанні цього методу, ви можете вказати два параметра:

Параметри:

departmentCode (обов'язковий): Код підрозділу, за яким потрібно отримати список співробітників.
deleted (опціональний): Визначає, чи включати видалених співробітників у список.
- true: Список включатиме і видалених співробітників.
- false: Список не буде містити видалених співробітників (за замовчуванням).

Приклад використання:

// Отримати список співробітників підрозділу з кодом "1" (без видалених)
$response = $syrve->employees->department('1');

// Отримати список співробітників підрозділу з кодом "1", включаючи видалених
$response = $syrve->employees->department('1', true);

Співробітник за ідентифікатором

Метод id() дозволяє отримати інформацію про співробітника за його унікальним ідентифікатором (ID) у системі Syrve. Для використання цього методу, вам потрібно передати обов'язковий параметр employeeId, який представляє собою унікальний ідентифікатор співробітника.

Параметри:

employeeId (обов'язковий): Унікальний ідентифікатор співробітника, за яким ви хочете отримати інформацію.

Приклад використання:

// Отримати інформацію про співробітника з ідентифікатором 'b8164def-74a7-471d-bb61-d612193f428b'
$response = $syrve->employees->id('b8164def-74a7-471d-bb61-d612193f428b');

Співробітник за кодом

Метод code() дозволяє отримати інформацію про співробітника за його кодом у системі Syrve. Для використання цього методу, вам потрібно передати обов'язковий параметр employeeCode, який представляє собою унікальний код співробітника.

Параметри:

employeeCode (обов'язковий): Унікальний код співробітника, за яким ви хочете отримати інформацію.

Приклад використання:

// Отримати інформацію про співробітника з кодом '1'
$response = $syrve->employees->code('1');

Створення співробітника

Метод create() дозволяє створити нового співробітника у системі Syrve. Для використання цього методу, вам потрібно передати деякі обов'язкові параметри, такі як code,name, та mainRoleCode, які визначають основні атрибути співробітника.

Параметри:

id (опціонально): Унікальний ідентифікатор співробітника, який створюється автоматично, якщо не вказати його явно.
code (обов'язковий): Код співробітника у системі Syrve.
name (обов'язковий): Ім'я співробітника.
mainRoleCode (обов'язковий): Код головної ролі співробітника.
departmentCodes (опціонально): Список кодів відділів, до яких належить співробітник.
responsibilityDepartmentCodes (опціонально): Список кодів відділів, за якими співробітник несе відповідальність.
pinCode (опціонально): PIN-код співробітника, який також створюється автоматично, якщо не передати його в запиті.

Уточнення:

Повний список параметрів та їх опис можна знайти в початковій частині розділу.
Параметри id та pinCode, якщо не передані, створюються автоматично. Ви можете передати власні значення для цих параметрів, якщо бажаєте контролювати їх.
У методі create() можна передавати значення null для параметрів, які не є обов'язковими. Наприклад, ви можете використовувати null, щоб створити співробітника без автоматично згенерованого pinCode. Використання null для параметра pinCode дозволяє залишити поле пустим.

Приклад використання:

// Створити нового співробітника з обов'язковими параметрами
$response = $syrve->employees->create([
  'code' => '1',
  'name' => 'Шевченко Микола',
  'mainRoleCode' => 'ROLE',
]);

// Створити нового співробітника зі своїми власними значеннями id та pinCode
$response = $syrve->employees->create([
  'id' => 'b8164def-74a7-471d-bb61-d612193f428b',
  'code' => '2',
  'name' => 'Мельник Володимир',
  'mainRoleCode' => 'ROLE',
  'pinCode' => '1234',
]);

// Створити нового співробітника без pinCode
$response = $syrve->employees->create([
  'id' => 'b8164def-74a7-471d-bb61-d612193f428b',
  'code' => '3',
  'name' => 'Іванов Іван',
  'mainRoleCode' => 'ROLE',
  'pinCode' => null,
]);

// Створити нового співробітника з вказанням певних відділів
$response = $syrve->employees->create([
  'code' => '4',
  'name' => 'Поліщук Олександр',
  'mainRoleCode' => 'ROLE',
  'departmentCodes' => ['1', '2'],
  'responsibilityDepartmentCodes' => ['1'],
]);

Редагувати співробітника

Метод edit() дозволяє змінювати дані співробітника у системі Syrve за його унікальним ідентифікатором (ID). Для використання цього методу, вам потрібно передати обов'язковий параметр id, який представляє собою унікальний ідентифікатор співробітника, якого ви бажаєте відредагувати.

Параметри:

id (обов'язковий): Унікальний ідентифікатор співробітника, якого потрібно відредагувати.
phone (опціонально): Новий телефонний номер співробітника.

Уточнення:

Повний список параметрів та їх опис можна знайти в початковій частині розділу.

Обмеження:

Метод edit() на даний момент не підтримує можливість закріпити співробітника за декількома департаментами.

Приклад використання:

// Змінити телефон співробітника з ідентифікатором 'b8164def-74a7-471d-bb61-d612193f428b'
$response = $syrve->employees->edit([
    'id' => 'b8164def-74a7-471d-bb61-d612193f428b',
    'phone' => '380950000000',
]);

Видалення співробітника

Метод delete() дозволяє видалити співробітника з системи Syrve за його унікальним ідентифікатором (ID). Для використання цього методу, вам потрібно передати обов'язковий параметр employeeId, який представляє собою унікальний ідентифікатор співробітника, якого ви бажаєте видалити.

Параметри:

employeeId (обов'язковий): Унікальний ідентифікатор співробітника, якого потрібно видалити.

Приклад використання:

// Видалити співробітника з ідентифікатором 'b8164def-74a7-471d-bb61-d612193f428b'
$response = $syrve->employees->delete('b8164def-74a7-471d-bb61-d612193f428b');