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

Материал из Planfix
Перейти к: навигация, поиск
(Новая страница: «Функция для получения списка статусов набора. Формат запроса: <source lang="xml"> <?xml version="1.0" encoding="U...»)
 
Нет описания правки
Строка 2: Строка 2:
<source lang="xml">
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<request method="projectGroup.getList">
<request method="taskStatus.getListOfSet">
   <account></account>
   <account></account>
   <sid></sid>
   <sid></sid>

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

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

<?xml version="1.0" encoding="UTF-8"?>
<request method="taskStatus.getListOfSet">
  <account></account>
  <sid></sid>
  <taskStatusSet>
     <id></id>
  </taskStatusSet>
  <signature></signature>
</request>
Название Тип Значение Примечание
taskStatusSet.id int Идентификатор набора статусов
signature string(32) подпись

Ответ:

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

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

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

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

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


Перейти