ПланФикс API action.add — различия между версиями

Материал из ПланФикс
Перейти к: навигация, поиск
(→‎Перейти)
Строка 1: Строка 1:
−
Добавление действия.  Можно добавить комментарий или тайм треккинг:
+
Добавление действия.  Неполная версия функции, будет доробатываться:
 
<source lang="xml">
 
<source lang="xml">
 
<?xml version="1.0" encoding="UTF-8"?>
 
<?xml version="1.0" encoding="UTF-8"?>
Строка 7: Строка 7:
 
   <action>
 
   <action>
 
     <description></description>
 
     <description></description>
−
    <timeTracker>
 
−
      <workDate></workDate>
 
−
      <beginTime></beginTime>
 
−
      <endTime></endTime>
 
−
      <workKind>
 
−
        <id></id>
 
−
        <name></name>
 
−
        <workType>
 
−
          <id></id>
 
−
          <name></name>
 
−
        </workType>
 
−
      </workKind>
 
−
    </timeTracker>
 
 
     <task>
 
     <task>
 
       <id></id>
 
       <id></id>
−
      <title></title>
 
 
     </task>
 
     </task>
 +
    <taskNewStatus></taskNewStatus>
 
     <notifiedList>
 
     <notifiedList>
 
       <user>
 
       <user>
Строка 31: Строка 18:
 
       </user>
 
       </user>
 
     </notifiedList>
 
     </notifiedList>
−
     <reminder>
+
     <isHidden></isHidden>
−
      <date></date>
 
−
    </reminder>
 
 
   </action>
 
   </action>
 
   <sirnature></sirnature>
 
   <sirnature></sirnature>
Строка 42: Строка 27:
 
|-
 
|-
 
|description ||string ||текст с описанием действия, комментарий ||
 
|description ||string ||текст с описанием действия, комментарий ||
−
|-
 
−
|timeTracker || ||таймтрекер || не обязательный параметр. если отсутствует, то это обычный комментарий
 
−
|-
 
−
|timeTracker.workDate||DateTime ||дата действия ||
 
−
|-
 
−
|timeTracker.beginTime||Time ||час начала ||
 
−
|-
 
−
|timeTracker.endTime||Time ||час окончания ||
 
−
|-
 
−
|timeTracker.workKind|| ||тип работы ||
 
−
|-
 
−
|timeTracker.workKind.id ||int ||идентификатор типа работы ||
 
−
|-
 
−
|timeTracker.workKind.workType || ||вид выполненной работы ||
 
−
|-
 
−
|timeTracker.workKind.workType.id ||int ||идентификатор выполненной работы ||
 
 
|-
 
|-
 
|task || ||задача, в рамках которой выполняется это действие ||
 
|task || ||задача, в рамках которой выполняется это действие ||
 
|-
 
|-
 
|task.id  ||int ||идентификатор задачи ||
 
|task.id  ||int ||идентификатор задачи ||
 +
|-
 +
|taskNewStatus  ||enum ||этим действием меняется статус задачи на указанный ||не обязательный параметр, перечень допустимых значений смотри в разделе [[ПланФикс API:Статусы задач|статусы задач]]
 
|-
 
|-
 
|notifiedList || ||этим действием необходимо уведомить следующих пользователей ||необязательный параметрполе
 
|notifiedList || ||этим действием необходимо уведомить следующих пользователей ||необязательный параметрполе
Строка 69: Строка 40:
 
|notifiedList.user.id ||int || идентификатор пользователя ||
 
|notifiedList.user.id ||int || идентификатор пользователя ||
 
|-
 
|-
−
|reminder || || ||необязательный параметр
+
|isHidden ||bool || является ли действие(комментарий) скрытым от всех пользователей, за исключением списка уведомленных пользователей || не обязательное поле, по умолчанию равно 0 (false)
−
|-
 
−
|reminder.date ||DateTime || дата когда необходимо уведомить ||
 
 
|-
 
|-
 
|}
 
|}
Строка 103: Строка 72:
  
 
== Перейти ==
 
== Перейти ==
−
*[[ПланФикс API]]
+
*[[ПланФикс API:Действия]]
 
*[[Коды ошибок]]
 
*[[Коды ошибок]]
−
*[[ПланФикс API:Действия]]
+
*[[Список функций]]

Версия 11:51, 16 декабря 2010

Добавление действия. Неполная версия функции, будет доробатываться: 

<?xml version="1.0" encoding="UTF-8"?>
<request method="action.add">
  <account></account>
  <sid></sid>
  <action>
    <description></description>
    <task>
      <id></id>
    </task>
    <taskNewStatus></taskNewStatus>
    <notifiedList>
      <user>
        <id></id>
        <id></id>
        <!-- ... -->
      </user>
    </notifiedList>
    <isHidden></isHidden>
  </action>
  <sirnature></sirnature>
</request>
Название Тип Значение Примечание
description string текст с описанием действия, комментарий
task задача, в рамках которой выполняется это действие
task.id int идентификатор задачи
taskNewStatus enum этим действием меняется статус задачи на указанный не обязательный параметр, перечень допустимых значений смотри в разделе статусы задач
notifiedList этим действием необходимо уведомить следующих пользователей необязательный параметрполе
notifiedList.user список пользователей которые получат уведомление
notifiedList.user.id int идентификатор пользователя
isHidden bool является ли действие(комментарий) скрытым от всех пользователей, за исключением списка уведомленных пользователей не обязательное поле, по умолчанию равно 0 (false)


Результат удачного выполнения запроса: 

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

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

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


Перейти

Источник — «http://planfix.ru/wiki/index.php?title=ПланФикс_API_action.add&oldid=843»