Метод: scheduleUserTermination
Параметры запроса
Параметр | Тип | Описание |
|---|---|---|
| credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
| userId (обязательный) | string | ID пользователя, для которого нужно выставить статус «Уволен» в указанную дату. |
| date (обязательный) | date | Дата запланированного увольнения в формате yyyy-mm-dd, например, 2020-12-27. |
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения или роль с индивидуальными настройками.
Администратор подразделения или пользователь с ролью с индивидуальными настройками могут запланировать дату увольнения для пользователей подразделений, которыми управляют, и их дочерние подразделений.
Возвращаемые значения
После того, как запрос успешно обработан, система отправляет объект со следующими свойствами:
Параметр | Тип | Описание |
|---|---|---|
| success | bool | true, если дата запланированного увольнения установлена. |
Возможные ошибки
Текст | Описание |
|---|---|
| Unknown user | Пользователь не найден. |
| Permission denied | Недостаточно прав для выполнения запроса. |
Пример запроса
| Блок кода | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
xmlns="https://ispringlearn.ru/go/services/api/soap">
<SOAP-ENV:Body>
<ScheduledUserTermination>
<credentials>
<accountUrl>https://myaccount.ispringlearn.ru</accountUrl>
<email>email@email.ru</email>
<password>password</password>
</credentials>
<userId>4b048e76-b8a2-11ea-a75f-7e104085dc3e</userId>
<date>2020-12-27</date>
</ScheduledUserTermination>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> |
Пример ответа
| Блок кода | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="https://ispringlearn.ru/go/services/api/soap">
<SOAP-ENV:Body>
<ns1:successResult>
<ns1:success>true</ns1:success>
</ns1:successResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> |