DeleteEmployee
к сведению
Вызов метода доступен только администраторам организации.
Удаляет сотрудника организации.
POST /DeleteEmployee
Параметры запроса
boxId— идентификатор ящика организации в формате GUID.userId— идентификатор пользователя.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у указанного ящика закончилась подписка на API.403— доступ к ящику с предоставленным авторизационным токеном запрещен или запрос сделан не от имени администратора.404— не найден сотрудник с указанным идентификатором.405— используется неподходящий HTTP-метод.409— нельзя удалить последнего администратора ящика.429— превышено ограничение на количество запросов в единицу времени.500— при обработке запроса возникла непредвиденная ошибка.
Если сотрудник уже был удален, то в результате выполнения метода ничего не произойдет, а запрос завершится успешно.
Примеры использования
Пример HTTP-запроса:
POST /DeleteEmployee?boxid={{boxid}}&userid={{userid}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json
Пример запроса с использованием C# SDK:
api.DeleteEmployee(boxId, userId);
См. также
Инструкции:
Методы для работы с сотрудниками:
- CreateEmployee — добавляет в организацию сотрудника с указанными реквизитами (доступно только администраторам ящика)
- DeleteEmployee — удаляет сотрудника организации (доступно только администраторам ящика)
- GetEmployee — возвращает данные сотрудника организации по указанному идентификатору (доступно только администраторам ящика)
- GetEmployees — возвращает список сотрудников указанной организации (доступно только администраторам ящика)
- GetEmployeesByExternalId — возвращает список сотрудников организации по идентификатору учетной записи в системе SSO-провайдера (доступно только администраторам ящика)
- GetMyEmployee — возвращает данные сотрудника организации, от имени которого вызывается метод
- GetSubscriptions — возвращает информацию о подписках сотрудника организации на почтовые уведомления
- UpdateEmployee — изменяет данные сотрудника организации (доступно только администраторам ящика)
- UpdateSubscriptions — изменяет подписки сотрудника организации на почтовые уведомления