ПланФикс API taskStatus.getListOfSet: различия между версиями
Материал из Planfix
								
												
				| Seva (обсуждение | вклад) Нет описания правки | Seva (обсуждение | вклад)  Нет описания правки | ||
| Строка 1: | Строка 1: | ||
| Функция для получения списка статусов набора. Возвращает все статусы, которые присутствуют в наборе.   | Функция для получения списка статусов набора. Возвращает все статусы, которые присутствуют в наборе.   | ||
| Для получения статусов в который можно перевести задачу в данный момент существует функция [[ПланФикс API task.getPossibleStatusToChange|task. | Для получения статусов в который можно перевести задачу в данный момент существует функция [[ПланФикс API task.getPossibleStatusToChange|task.getPossibleStatusToChange]] | ||
| Формат запроса: | Формат запроса: | ||
Версия от 07:10, 31 июля 2013
Функция для получения списка статусов набора. Возвращает все статусы, которые присутствуют в наборе. Для получения статусов в который можно перевести задачу в данный момент существует функция task.getPossibleStatusToChange
Формат запроса:
<?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>