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

Материал из Planfix
Перейти к: навигация, поиск

Функция получения информации о пользователе. Формат запроса:

<?xml version="1.0" encoding="UTF-8"?>
<request method="user.add">
  <account></account>
  <sid></sid>
  <user>
    <id></id>
  </user>
  <signature></signature>
</request>
Название Тип Значение Примечание
user.id int идентификатор пользователя
signature string(32) подпись

Ответ:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <user>
    <id></id>
    <name></name>
    <lastName></lastName>
    <login></login>
    <email></email>
    <role></role>
    <status></status>
    <notify>
      <byEmail></byEmail>
      <byJabber></byJabber>
      <byPlanfix></byPlanfix>
    </notify>
    <birthdate></birthdate>
    <sex></sex>
    <phone></phone>
    <coeff></coeff>
    <timezone></timezone>
    <useDst></useDst>
    <isInvisibleOutOfGroup></isInvisibleOutOfGroup>
    <isBlindOutOfGroup></isBlindOutOfGroup>
    <userPic></userPic>
    <isOnline></isOnline>
    <userGroups>
      <userGroup>
        <id></id>
        <name></name>
      </userGroup>
      <userGroup>
        <id></id>
        <name></name>
      </userGroup>
      <!-- ... -->
    </userGroups>
  </user>
</response>
Название Тип Значение Примечание
id int
name string имя, отчество пользователя
lastName string фамилия пользователя
login string имя учетной записи в системе
email string электронный адрес почты
role enum роль пользователя в системе
status enum статус список допустимых значений смотри в разделе статусы пользователей
notify уведомления
notify.byEmail bool получать уведомления по электронной почте
notify.byJabber bool получать уведомления по jabber
notify.byPlanfix bool получать уведомления по внутренней системе уведомлений ПланФикс
birthdate DateTime дата рождения
sex enum пол сотрудника список допустимых значений смотри в разделе пол сотрудника
phone string телефон
coeff float личный коэффициент доступно для пользователей с правами администратор
timezone int часовой пояс
useDst bool переход на летнее время
isInvisibleOutOfGroup bool true=Видит только членов своих групп; false=Видит всех сотрудников доступно для пользователей с правами администратор
isBlindOutOfGroup bool true=Его видят только члены его групп; false=Его видят все сотрудники доступно для пользователей с правами администратор
userPic string URL?
userGroups список групп в которых состоит пользователь
userGroups.userGroup группа
userGroups.userGroup.id int идентификатор группы
userGroups.userGroup.name string название группы

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

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


Перейти