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

Версия от 07:05, 24 августа 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>

Значение code	Расшифровка
0000	неизвестная ошибка

Перейти

@@ Строка 18: / Строка 18: @@
 !width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание
 |-
-|name ||string || ||
+|name ||string ||имя, отчество пользователей ||
 |-
-|lastName ||string || ||
+|lastName ||string ||фамилия пользователя ||
 |-
-| email||string || ||
+| email||string || email пользователя ||
 |-
-|role ||enum || ||
+|role ||enum ||роль пользователя в системе || допустимые значения ''ADMIN'', '''USER'''. полный список смотри в разделе [[ПланФикс API:Роли пользователей|роли пользователей]]
 |-
-|status || enum|| ||
+|status || enum|| статус пользователя || список допустимых значений смотри в разделе [[ПланФикс API:Статусы пользователей|статусы пользователей]]
 |-
-|signature ||string(32) || ||
+|signature ||string(32) ||подпись ||
 |-
 |}