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

Материал из Planfix
Перейти к: навигация, поиск
Нет описания правки
Нет описания правки
Строка 10: Строка 10:
#[[ПланФикс API task.changeWorkers|task.changeWorkers / Изменить (добавить/удалить) исполнителей]]
#[[ПланФикс API task.changeWorkers|task.changeWorkers / Изменить (добавить/удалить) исполнителей]]


== task.accept Принять задачу ==
Для дальнейшей работы с задачей, пользователь должен принять задачу. Вызов функции:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request method="task.accept">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <task>
    <id>идентификатор задачи, которую принимает пользователь</id>
  </task>
</request>
</source>
Результатом корректного выполнения запроса будет:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <task>
    <id></id>
  </task>
</response>
</source>
== task.reject Отклонить задачу ==
Для отклонения задачи, необходимо вызвать следующую функцию:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request method="task.reject">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <task>
    <id>идентификатор задачи, которую принимает пользователь</id>
  </task>
  <reason>причина по которой отклоняется задача,обязательное поле, не может быть пустым</reason>
</request>
</source>
Результатом удачного выполнения функции будет следующий ответ?
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <task>
    <id></id>
  </task>
</response>
</source>
== task.changeExpectDate Изменить дату выполнения задачи ==
Если пользователь по какой-то причине не может выполнить в установленный срок задачу, он может перенести время выполнения её.
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request method="task.changeExpectDate">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <task>
    <id>идентификатор задачи, которую принимает пользователь</id>
  </task>
  <expectDate></expectDate>
</request>
</source>
При успешном выполнении получим следующий ответ:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <task>
    <id></id>
    <endTime></endTime>
  </task>
</response>
</source>
Если в ответе отсутствует параметр '''endTime''' - это говорит о том, что был послан запрос постановщику с предложением о смене даты.
== task.changeStatus Изменить статус задачи ==
Изменение статуса:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request method="task.changeExpectDate">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <task>
    <id><!-- идентификатор задачи --></id>
  </task>
  <status></status>
</request>
</source>
Ответ:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <task>
    <id></id>
  </task>
</response>
</source>
== task.changeWorkers Изменить (добавить/удалить) исполнителей ==
Запрос на изменение исполнителей.
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request method="task.changeWorkers">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <task>
    <id></id>
  </task>
  <workers>
    <users>
      <id></id>
      <id></id>
      <!-- ... -->
    </users>
  </workers>
</request>
</source>
Важно понимать, что необходимо посылать полный список исполнителей, сервер автоматически рассчитает кого необходимо удалить, а кого добавить, и кого необходимо оставить.
Ответ:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <task>
    <id></id>
  </task>
</response>
</source>
== Константы ==
=== Срочность ===
*'''LOW''' - Не срочная
*'''AVERAGE''' - Обычная
*'''HIGH''' - Срочная
=== Статус ===
*'''DRAFT''' - Черновик
*'''ACTIVE''' - Активный но еще не принятый
*'''ACCEPTED''' - Принятый
*'''COMPLETED''' - Завершенный
*'''DELAYED''' - Отложенный
*'''REJECTED''' - Отклоненный
*'''DONE''' - Выполненный
*'''CANCELED''' - Отмененный
=== Типы сортировок ===
*'''NUMBER_ASC''' - сортировка по номеру (возрастание)
*'''NUMBER_DESC''' - сортировка по номеру (убывание)
*'''IMPORTANCE_ASC''' - сортировка по приоритету (возрастание)
*'''IMPORTANCE_DESC''' - сортировка по приоритету (убывание)
*'''DEADLINE_ASC''' - сортировка по времени окончания (возрастание)
*'''DEADLINE_DESC''' - сортировка по времени окончания (убывание)
*'''TASKTITLE_ASC''' - сортировка по названию задачи (возрастание)
*'''TASKTITLE_DESC''' - сортировка по названию задачи (убывание)
*'''PROJECT_ASC''' - сортировка по названию проекта (возрастание)
*'''PROJECT_DESC''' - сортировка по названию проекта (убывание)
== Ошибки ==
по ходу реализации раздел дополниться, сей час не понятен полный список возможных ошибок


== Перейти ==
== Перейти ==
[[ПланФикс API]]
[[ПланФикс API]]

Версия от 11:07, 23 августа 2010