ПланФикс API: Задачи

Материал из ПланФикс
Версия от 13:07, 9 августа 2010; Seva (обсуждение | вклад) (Константы)
Перейти к: навигация, поиск

Список функций для управления задачами

task.add Добавление задачи

Добавление:

<?xml version="1.0" encoding="UTF-8"?>
<request method="task.add">
  <account><!-- имя аккаунта --></account>
  <sid><!-- ключ сессии, полученный после аутентификации --></sid>
  <task>
    <title><!-- Название задачи --></title>
    <description><!-- О чем эта задача --></description>
    <importance><!-- Срочность  --></importance>
    <status><!-- Статус --></status>
    <checkResult>{true|false}</checkResult><!-- Является ли задача задачей с обязательной проверкой результата -->
	<!-- Создатель задачи -->
    <owner>
      <id></id>
    </owner>
	<!-- Над задача -->
    <parent>
      <id></id>
    </parent>
	<!-- В рамках какого проекта поставлена задача -->
    <project>
      <id></id>
    </project>
	<!-- Контрагент -->
    <client>
      <id></id>
    </client>
    <startTime><!-- Время начала (приступить к работе) --></startTime>
    <endTime><!-- Время окончания (закончить работу До) --></endTime>
  </task>
</request>

Ответ при удачном выполнении операции:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
	<task>
		<id></id>
	</task>
</response>

task.update Обновление задачи

task.get Получение карточки задачи

Запрос на получение:

<?xml version="1.0" encoding="UTF-8"?>
<request method="task.get">
	<account><!-- имя аккаунта --></account>
	<sid><!-- ключ сессии, полученный после аутентификации --></sid>
	<id></id>
</request>


Ответ:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
	<task>
		<id></id>
		<title><!-- Название задачи --></title>
		<description><!-- О чем эта задача --></description>
		<importance><!-- Срочность  --></importance>
		<status><!-- Статус --></status>
		<checkResult>{true|false}</checkResult><!-- Является ли задача задачей с обязательной проверкой результата -->
		<!-- Создатель задачи -->
		<owner>
			<id></id>
			<name></name>
		</owner>
		<!-- Над задача -->
		<parent>
			<id></id>
		</parent>
		<!-- В рамках какого проекта поставлена задача -->
		<project>
			<id></id>
			<title></title>
		</project>
		<!-- Контрагент -->
		<client>
			<id></id>
			<name></name>
		</client>
		<beginDateTime><!-- Время создания задачи --></beginDateTime>
		<startTime><!-- Время начала (приступить к работе) --></startTime>
		<endTime><!-- Время окончания (закончить работу До) --></endTime>
		<!-- Сквозной номер -->
		<general></general>

		<isOverdued><!-- Задача не выполнена в срок --></isOverdued>
		<isCloseToDeadline><!-- Задача близка к дедлайну --></isCloseToDeadline>
		<isNotAcceptedInTime><!-- Задача не принята вовремя --></isNotAcceptedInTime>
		<!-- Помещена в избранные -->
		<starred>{true|false}</starred>
	</task>
</response>

task.getList Список задач

task.attachFile Прикрепить файл (скорее всего перенесем эту функцию)

Константы

Срочность

  • LOW - Не срочная
  • AVERAGE - Обычная
  • HIGH - Срочная

Статус

  • DRAFT - Черновик
  • ACTIVE - Активный но еще не принятый
  • ACCEPTED - Принятый
  • COMPLETED - Завершенный
  • DELAYED - Отложенный
  • REJECTED - Отклоненный
  • DONE - Выполненный
  • CANCELED - Отмененный

Переодичность, тип

  • DAYLY - ежедневно
  • WEEKLY - еженедельно
  • MONTHLY - ежемесячно