ПланФикс API user.add

Материал из ПланФикс
Версия от 09:16, 22 июня 2018; Seva (обсуждение | вклад)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)
Перейти к: навигация, поиск

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

<?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>
    <post>
      <id></id>
    </post>
    <phones>
        <phone>
            <number></number>
            <typeId></typeId>
            <typeName></typeName>
        </phone>
        <!-- ... -->
    </phones>
  </user>
  <signature></signature>
</request>
Название Тип Значение Примечание
name 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>


Перейти