ПланФикс API taskStatus.getSetList — различия между версиями
Материал из ПланФикс
Seva (обсуждение | вклад) |
Seva (обсуждение | вклад) |
||
Строка 1: | Строка 1: | ||
− | Функция для получения списка | + | Функция для получения списка процессов задач. Формат запроса: |
<source lang="xml"> | <source lang="xml"> | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
Строка 31: | Строка 31: | ||
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание | !width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание | ||
|- | |- | ||
− | |'''taskStatusSets ''' || || корневой элемент, содержит список | + | |'''taskStatusSets ''' || || корневой элемент, содержит список процессов задач || |
|- | |- | ||
− | |'''taskStatusSets ''' totalCount||int ||количество | + | |'''taskStatusSets ''' totalCount||int ||количество процессов задач || |
|- | |- | ||
− | |taskStatusSet|| || корневой элемент, описывающий | + | |taskStatusSet|| || корневой элемент, описывающий процесс в списке || |
|- | |- | ||
− | |id ||int ||идентификатор | + | |id ||int ||идентификатор процесса || |
|- | |- | ||
− | |name ||string || название | + | |name ||string || название процесса|| |
|- | |- | ||
|} | |} | ||
− | Пустой ответ не '''генерирует ошибку'''. Если в результирующую выборку не попадают никакие | + | Пустой ответ не '''генерирует ошибку'''. Если в результирующую выборку не попадают никакие процессы, то ответ будет иметь следующую форму: |
<source lang="xml"> | <source lang="xml"> | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> |
Текущая версия на 13:49, 18 января 2018
Функция для получения списка процессов задач. Формат запроса:
<?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>