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

Материал из Planfix
Перейти к: навигация, поиск
(Новая страница: «Функция для получения списка наборов статусов. Формат запроса: <source lang="xml"> <?xml version="1.0" encoding=...»)
 
Нет описания правки
Строка 25: Строка 25:
     </taskStatusSet>
     </taskStatusSet>
     <!-- ... -->
     <!-- ... -->
   </projectGroups>
   </taskStatusSets>
</response>
</response>
</source>
</source>

Версия от 07:51, 5 июля 2013

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

<?xml version="1.0" encoding="UTF-8"?>
<request method="taskStatus.getSetList">
  <account></account>
  <sid></sid>
  <signature></signature>
</request>
Название Тип Значение Примечание
signature string(32) подпись

Ответ:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <taskStatusSets totalCount="totalCount">
    <taskStatusSet>
      <id></id>
      <name></name>
    </taskStatusSet>
    <!-- ... -->
  </taskStatusSets>
</response>
Название Тип Значение Примечание
taskStatusSets корневой элемент, содержит список наборов статусов
taskStatusSets totalCount int количество наборов статусов
taskStatusSet корневой элемент, описывающий набор статусов в списке
id int идентификатор набора статусов
name string название набора статусов

Пустой ответ не генерирует ошибку. Если в результирующую выборку не попадают никакие наборы статусов, то ответ будет иметь следующую форму:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <taskStatusSets totalCount="0"></taskStatusSets>
</response>

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

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


Перейти