Как удалить сотрудника через 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