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

Материал из Planfix
Перейти к: навигация, поиск
(Новая страница: «Функция задает '''новый''' список исполнителей задачи. Формат вызова функции: <source lang="xml"> <?xml ...»)
 
Нет описания правки
 
(не показаны 4 промежуточные версии 2 участников)
Строка 1: Строка 1:
Функция задает '''новый''' список исполнителей задачи. Формат вызова функции:
Функция используется для изменения списка исполнителей задачи. Формат вызова функции:
<source lang="xml">
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
Строка 7: Строка 7:
   <task>
   <task>
     <id></id>
     <id></id>
    <workers>
      <addUsers>
        <id></id>
        <id></id>
        <!-- ... -->
      </addUsers>
      <addGroups>
        <id></id>
        <id></id>
        <!-- ... -->
      </addGroups>
      <delUsers>
        <id></id>
        <id></id>
        <!-- ... -->
      </delUsers>
      <delGroups>
        <id></id>
        <id></id>
        <!-- ... -->
      </delGroups>
    </workers>
   </task>
   </task>
  <workers>
    <users>
      <id></id>
      <id></id>
      <!-- ... -->
    </users>
    <groups>
      <id></id>
      <id></id>
      <!-- ... -->
    </groups>
  </workers>
   <signature></signature>
   <signature></signature>
</request>
</request>
Строка 28: Строка 38:
|task.id ||int || идентификатор задачи||
|task.id ||int || идентификатор задачи||
|-
|-
|workers || || корневой элемент ||
|workers || ||корневой элемент списка исполнителей задачи ||
|-
|-
|workers.users || || список пользователей, которым поставлена задача ||
|workers.addUsers || || корневой элемент списка пользователей, которые подключаются к задаче ||  
|-
|-
|workers.users.id ||int ||идентификатор пользователя ||
|workers.addUsers.id ||int ||идентификатор пользователя, который подключается к задаче ||
|-
|-
|workers.groups || ||список групп, которым поставлена задача ||
|workers.addGroups || ||корневой элемент списка групп, которые подключаются к задаче||
|-
|-
|workers.groups.id ||int || идентификатор группы ||
|workers.addGroups.id ||int || идентификатор группы||
|-
|workers.delUsers || || корневой элемент списка пользователей, которые удаляются из списка исполнителей ||
|-
|workers.delUsers.id ||int ||идентификатор пользователя, который удаляется из списка исполнителей ||
|-
|workers.delGroups || ||корневой элемент списка групп, которые удаляются из списка исполнителей ||
|-
|workers.delGroups.id ||int || идентификатор группы||
|-
|-
|signature ||string(32) ||подпись ||
|signature ||string(32) ||подпись ||
|-
|-
|}
|}
Важно понимать, что необходимо посылать полный список исполнителей, сервер автоматически рассчитает кого необходимо удалить, а кого добавить, и кого необходимо оставить.




Строка 68: Строка 85:
</response>
</response>
</source>
</source>
{| class="wikitable" style="margin-top: 1em; width:100% "
!width="50"|Значение ''code'' !! Расшифровка
|-
|align="center"| 0000|| неизвестная ошибка
|-
|}






== Перейти ==
== Перейти ==
*[[ПланФикс API]]
*[[ПланФикс API:Задачи]]
*[[ПланФикс API:Задачи]]
*[[Коды ошибок]]
*[[Список функций]]

Текущая версия от 08:07, 28 апреля 2021

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

<?xml version="1.0" encoding="UTF-8"?>
<request method="task.changeWorkers">
  <account></account>
  <sid></sid>
  <task>
    <id></id>
    <workers>
      <addUsers>
        <id></id>
        <id></id>
        <!-- ... -->
      </addUsers>
      <addGroups>
        <id></id>
        <id></id>
        <!-- ... -->
      </addGroups>
      <delUsers>
        <id></id>
        <id></id>
        <!-- ... -->
      </delUsers>
      <delGroups>
        <id></id>
        <id></id>
        <!-- ... -->
      </delGroups>
    </workers>
  </task>
  <signature></signature>
</request>
Название Тип Значение Примечание
task.id int идентификатор задачи
workers корневой элемент списка исполнителей задачи
workers.addUsers корневой элемент списка пользователей, которые подключаются к задаче
workers.addUsers.id int идентификатор пользователя, который подключается к задаче
workers.addGroups корневой элемент списка групп, которые подключаются к задаче
workers.addGroups.id int идентификатор группы
workers.delUsers корневой элемент списка пользователей, которые удаляются из списка исполнителей
workers.delUsers.id int идентификатор пользователя, который удаляется из списка исполнителей
workers.delGroups корневой элемент списка групп, которые удаляются из списка исполнителей
workers.delGroups.id int идентификатор группы
signature string(32) подпись


Ответ:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <task>
    <id></id>
  </task>
</response>
Название Тип Значение Примечание
task.id int идентификатор задачи


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

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


Перейти