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

Текущая версия на 07:25, 17 ноября 2021

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

<?xml version="1.0" encoding="UTF-8"?>
<request method="user.add">
  <account></account>
  <sid></sid>
  <user>
    <name>Имя</name>
    <midName>Отчество</midName>
    <lastName>Фамилия</lastName>
    <email></email>
    <role></role>
    <status></status>
    <post>
      <id></id>
    </post>
    <phones>
        <phone>
            <number></number>
            <typeId></typeId>
            <typeName></typeName>
        </phone>
        <!-- ... -->
    </phones>
  </user>
  <signature></signature>
</request>

Название	Тип	Значение	Примечание
name	string	имя пользователя
midName	string	отчество пользователя
lastName	string	фамилия пользователя
email	string	email пользователя
role	enum	роль пользователя в системе	допустимые значения ADMIN, USER. полный список смотри в разделе роли пользователей
post.id	int	идентификатор должности	не обязательное поле
status	enum	статус пользователя	список допустимых значений смотри в разделе статусы пользователей
phones	string	телефоны
phone.number	string	номер телефона
phone.typeId	int	идентификатор типа номера	допустимые значения можно получить функцией contact.getPhoneTypes
phone.typeName	string	название типа номера
signature	string(32)	подпись

Ответ:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <user>
    <id></id>
  </user>
</response>

Название	Тип	Значение	Примечание
id	int	идентификатор созданного пользователя

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

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

Перейти

@@ Строка 6: / Строка 6: @@
    <sid></sid>
    <user>
-     <name>Имя Отчество</name>
+     <name>Имя</name>
+    <midName>Отчество</midName>
      <lastName>Фамилия</lastName>
      <email></email>
      <role></role>
      <status></status>
+    <post>
+      <id></id>
+    </post>
+    <phones>
+        <phone>
+            <number></number>
+            <typeId></typeId>
+            <typeName></typeName>
+        </phone>
+        <!-- ... -->
+    </phones>
    </user>
    <signature></signature>
@@ Строка 18: / Строка 30: @@
 !width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание
 |-
-|name ||string ||имя, отчество пользователей ||
+|name ||string ||имя пользователя ||
+|-
+|midName ||string ||отчество пользователя ||
 |-
 |lastName ||string ||фамилия пользователя ||
@@ Строка 25: / Строка 39: @@
 |-
 |role ||enum ||роль пользователя в системе || допустимые значения ''ADMIN'', '''USER'''. полный список смотри в разделе [[ПланФикс API:Роли пользователей|роли пользователей]]
+|-
+|post.id || int || идентификатор должности || не обязательное поле
 |-
 |status || enum|| статус пользователя || список допустимых значений смотри в разделе [[ПланФикс API:Статусы пользователей|статусы пользователей]]
+|-
+|phones || string||телефоны ||
+|-
+|phone.number||string ||номер телефона ||
+|-
+|phone.typeId||int || идентификатор типа номера|| допустимые значения можно получить функцией [[ПланФикс API contact.getPhoneTypes|contact.getPhoneTypes]]
+|-
+|phone.typeName||string || название типа номера||
 |-
 |signature ||string(32) ||подпись ||
@@ Строка 38: / Строка 62: @@
    <user>
      <id></id>
-    <isActivated></isActivated>
    </user>
 </response>
@@ Строка 46: / Строка 69: @@
 |-
 |id || int||идентификатор созданного пользователя ||
-|-
-|isActivated ||bool ||состояние пользователя, активный/неактивный ||в принципе будет равно ''false'', т.к. пользователь навряд ли будет активирован на этот момент.
 |-
 |}