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

Версия 15:42, 16 декабря 2010

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

<?xml version="1.0" encoding="UTF-8"?>
<request method="action.update">
  <account></account>
  <sid></sid>
  <action>
    <id></id>
    <description></description>
    <taskNewStatus></taskNewStatus>
    <notifiedList>
      <user>
        <id></id>
        <id></id>
        <!-- ... -->
      </user>
    </notifiedList>
    <isHidden></isHidden>
  </action>
  <signature></signature>
</request>

Название	Тип	Значение	Примечание
id	int	идентификатор действия
description	string	текст с описанием действия, комментарий
taskNewStatus	enum	этим действием меняется статус задачи на указанный	не обязательный параметр, перечень допустимых значений смотри в разделе статусы задач
notifiedList		этим действием необходимо уведомить следующих пользователей
notifiedList.user		список пользователей которые получат уведомление
notifiedList.user.id	int	идентификатор пользователя
isHidden	bool	является ли действие(комментарий) скрытым от всех пользователей, за исключением списка уведомленных пользователей	не обязательное поле, по умолчанию равно 0 (false)
signature	string(32)	подпись

Помните, можно обновлять действия с типом ACTION и COMMENT. Остальные попытки будут вызывать ошибку.

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

<?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>

Перейти

@@ Строка 8: / Строка 8: @@
      <id></id>
      <description></description>
-     <timeTracker>
+     <taskNewStatus></taskNewStatus>
-      <workDate></workDate>
-      <beginTime></beginTime>
-      <endTime></endTime>
-      <workKind>
-        <id></id>
-        <workType>
-          <id></id>
-        </workType>
-      </workKind>
-    </timeTracker>
      <notifiedList>
        <user>
@@ Строка 26: / Строка 16: @@
        </user>
      </notifiedList>
-     <reminder>
+     <isHidden></isHidden>
-      <date></date>
-    </reminder>
    </action>
    <signature></signature>
@@ Строка 40: / Строка 28: @@
 |description ||string ||текст с описанием действия, комментарий ||
 |-
-|timeTracker || ||таймтрекер ||
+|taskNewStatus  ||enum ||этим действием меняется статус задачи на указанный ||не обязательный параметр, перечень допустимых значений смотри в разделе [[ПланФикс API:Статусы задач|статусы задач]]
-|-
-|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.id  ||int ||идентификатор задачи ||
 |-
 |notifiedList || ||этим действием необходимо уведомить следующих пользователей ||
@@ Строка 66: / Строка 36: @@
 |notifiedList.user.id ||int || идентификатор пользователя ||
 |-
-|reminder || ||  ||необязательный параметр
+|isHidden ||bool || является ли действие(комментарий) скрытым от всех пользователей, за исключением списка уведомленных пользователей || не обязательное поле, по умолчанию равно 0 (false)
-|-
-|reminder.date ||DateTime || дата когда необходимо уведомить ||
 |-
 |signature ||string(32)|| подпись ||