ПланФикс API action.getListByPeriod: различия между версиями
Материал из Planfix
Alice (обсуждение | вклад) Нет описания правки |
Alice (обсуждение | вклад) Нет описания правки |
||
Строка 1: | Строка 1: | ||
{{#seo: | |||
|title= ПланФикс API action.getListByPeriod | |||
|titlemode=append | |||
|keywords=планфикс, действия, апи, api | |||
|description= ПланФикс API action.getListByPeriod | |||
}} | |||
Получение списка всех действий за заданный период времени: | Получение списка всех действий за заданный период времени: | ||
<source lang="xml"> | <source lang="xml"> |
Версия от 11:33, 18 ноября 2017
Получение списка всех действий за заданный период времени:
<?xml version="1.0" encoding="UTF-8"?>
<request method="action.getListByPeriod">
<account></account>
<sid></sid>
<fromDate></fromDate>
<toDate></toDate>
<pageCurrent></pageCurrent>
<pageSize></pageSize>
<sort></sort>
<task>
<id></id>
</task>
<signature></signature>
</request>
Название | Тип | Значение | Примечание |
---|---|---|---|
fromDate | DateTime | начало периода | |
toDate | DateTime | конец периода | |
pageCurrent | int | текущая страница | |
pageSize | int | размер запрашиваемой страницы | не может превышать 100 |
sort | enum: {asc,desc} | сортировка списка | необязательный параметр, по умолчанию desc |
task.id | int | идентификатор задачи | необязательный параметр, по умолчанию выбираются действия по всем задачам |
signature | string(32) | подпись |
Ответ:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<actions count="count" totalCount="totalCount">
<action><!-- ... --></action>
<action><!-- ... --></action>
<!-- ... -->
</actions>
</response>
Название | Тип | Значение | Примечание |
---|---|---|---|
actions | корневой узел содержащий список действий | ||
actions count | int | количество действий в ответе | |
actions totalCount | int | количество действий удовлетворяющих запросу | |
action | действие. описание параметра смотри в разделе action.get / Получить действие |
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>