Як видалити співробітника через API?

DELETE /v1/employees/{employeeId} видаляє співробітника в межах tenant-контексту. Успішна відповідь — 204 No Content.

Endpoint

Параметр	Значення
Method	DELETE
Path	/v1/employees/{employeeId}
Base URL	https://smartway.pro/api
Auth	Bearer token
Required scope	employees.write

Призначення

Endpoint використовується для видалення співробітника за employeeId.

Операція виконується в межах tenant-контексту з Bearer token.

Передумови

Клієнт має передати валідний Bearer token.
Token має містити company context.
Token має містити scope employees.write.
idCompany не передається окремо.
employeeId має належати співробітнику в межах поточного tenant-а.

Запит

Path parameters

Параметр	Тип	Обов’язковий	Опис
employeeId	int64	так	ID співробітника.

curl приклад

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

curl -X DELETE 'https://smartway.pro/api/v1/employees/4432' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Accept: application/json'

Відповідь

Успішна відповідь: 204 No Content. Успішна відповідь не містить body.

Поля відповіді

Delete response

Елемент	Тип	Опис
HTTP status	204 No Content	Операція виконана успішно.
Response body	відсутній	Body не повертається.

Бізнес-логіка

BFF бере companyId з Bearer token, а не з параметрів запиту.
Endpoint видаляє співробітника тільки в межах поточного tenant-контексту.
Для доступу потрібен scope employees.write.

Edge cases

Edge cases

Сценарій	Поведінка API
employeeId не знайдено в поточному tenant-і	API повертає 404 Not Found.
Bearer token без employees.write	API повертає 403 Forbidden.
Операція успішна	API повертає 204 No Content без body.
Клієнт передає idCompany	Endpoint не використовує idCompany з клієнтського запиту.

Помилки

Error responses

HTTP status	Коли виникає
401 Unauthorized	Bearer token відсутній або невалідний.
403 Forbidden	Недостатньо прав або token без company context.
404 Not Found	Співробітника не знайдено в межах поточного tenant-а.
500 Internal Server Error	Неочікувана помилка BFF.
503 Service Unavailable	Збій внутрішньої інтеграції BFF -> back2.

Використання

Видалити співробітника з LMS Smart Way через інтеграцію.
Очистити тестові записи після перевірки інтеграції.
Прибрати співробітника, який більше не має бути в employee dataset.

Типові помилки

Typical integration mistakes

Типова помилка	Як правильно
Очікувати JSON у відповіді	Успішна відповідь — 204 No Content без body.
Передавати idCompany	Не передавайте idCompany; companyId береться з Bearer token.
Використовувати token без employees.write	Для DELETE потрібен scope employees.write.

FAQ

Що повертає API після успішного видалення?

204 No Content без response body.

Чи потрібно передавати idCompany?

Ні. companyId береться з Bearer token.

Що буде, якщо employeeId не знайдено?

API поверне 404 Not Found.

Appearance

Language