ПланФикс API user.add: различия между версиями

Материал из Planfix
Перейти к: навигация, поиск
Нет описания правки
Строка 58: Строка 58:
</response>
</response>
</source>
</source>
{| class="wikitable" style="margin-top: 1em; width:100% "
 
!width="50"|Значение ''code'' !! Расшифровка
|-
|align="center"| 0000|| неизвестная ошибка
|-
|}





Версия от 12:29, 27 октября 2010

Функция добавления нового пользователя. Выполнение данной функции разрешено пользователю с админ правами. Формат запроса:

<?xml version="1.0" encoding="UTF-8"?>
<request method="user.add">
  <account></account>
  <sid></sid>
  <user>
    <name>Имя Отчество</name>
    <lastName>Фамилия</lastName>
    <email></email>
    <role></role>
    <status></status>
  </user>
  <signature></signature>
</request>
Название Тип Значение Примечание
name string имя, отчество пользователей
lastName string фамилия пользователя
email string email пользователя
role enum роль пользователя в системе допустимые значения ADMIN, USER. полный список смотри в разделе роли пользователей
status enum статус пользователя список допустимых значений смотри в разделе статусы пользователей
signature string(32) подпись

Ответ:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <user>
    <id></id>
    <isActivated></isActivated>
  </user>
</response>
Название Тип Значение Примечание
id int идентификатор созданного пользователя
isActivated bool состояние пользователя, активный/неактивный в принципе будет равно false, т.к. пользователь навряд ли будет активирован на этот момент.

В противном случае будет возвращен ответ с ошибкой:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>


Перейти