ПланФикс API user.add — различия между версиями
Материал из ПланФикс
Seva (обсуждение | вклад) |
Seva (обсуждение | вклад) |
||
(не показана 1 промежуточная версия этого же участника) | |||
Строка 6: | Строка 6: | ||
<sid></sid> | <sid></sid> | ||
<user> | <user> | ||
− | <name>Имя Отчество</ | + | <name>Имя</name> |
+ | <midName>Отчество</midName> | ||
<lastName>Фамилия</lastName> | <lastName>Фамилия</lastName> | ||
<email></email> | <email></email> | ||
Строка 14: | Строка 15: | ||
<id></id> | <id></id> | ||
</post> | </post> | ||
+ | <phones> | ||
+ | <phone> | ||
+ | <number></number> | ||
+ | <typeId></typeId> | ||
+ | <typeName></typeName> | ||
+ | </phone> | ||
+ | <!-- ... --> | ||
+ | </phones> | ||
</user> | </user> | ||
<signature></signature> | <signature></signature> | ||
Строка 21: | Строка 30: | ||
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание | !width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание | ||
|- | |- | ||
− | |name ||string ||имя | + | |name ||string ||имя пользователя || |
+ | |- | ||
+ | |midName ||string ||отчество пользователя || | ||
|- | |- | ||
|lastName ||string ||фамилия пользователя || | |lastName ||string ||фамилия пользователя || | ||
Строка 32: | Строка 43: | ||
|- | |- | ||
|status || enum|| статус пользователя || список допустимых значений смотри в разделе [[ПланФикс API:Статусы пользователей|статусы пользователей]] | |status || enum|| статус пользователя || список допустимых значений смотри в разделе [[ПланФикс API:Статусы пользователей|статусы пользователей]] | ||
+ | |- | ||
+ | |phones || string||телефоны || | ||
+ | |- | ||
+ | |phone.number||string ||номер телефона || | ||
+ | |- | ||
+ | |phone.typeId||int || идентификатор типа номера|| допустимые значения можно получить функцией [[ПланФикс API contact.getPhoneTypes|contact.getPhoneTypes]] | ||
+ | |- | ||
+ | |phone.typeName||string || название типа номера|| | ||
|- | |- | ||
|signature ||string(32) ||подпись || | |signature ||string(32) ||подпись || |
Текущая версия на 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 | фамилия пользователя | |
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>