ПланФикс API user.changeStatus
Материал из Planfix
Позволяет установить статус, если передан/задан параметр status. Если параметр опущен, то статус будет поменян на противоположный установленному. Функция доступна пользователю с правами администратор. Формат запроса:
<?xml version="1.0" encoding="UTF-8"?>
<request method="user.changeStatus">
<account></account>
<sid></sid>
<user>
<id></id>
<status></status>
</user>
<signature></signature>
</request>
Название | Тип | Значение | Примечание |
---|---|---|---|
id | int | идентификатор пользователя | |
status | enum | новый статус | необязательный параметр. Список доступных значений смотри в разделе статусы пользователей |
signature | string(32) | подпись |
В ответе будет передан параметр статус с указанием установленного статуса.
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<user>
<id></id>
</user>
</response>
Название | Тип | Значение | Примечание |
---|---|---|---|
user.id | int | идентификатор пользователя |
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>
Значение code | Расшифровка |
---|---|
0000 | неизвестная ошибка |