ПланФикс API action.getListByPeriod
Материал из Planfix
Получение списка всех действий за заданный период времени:
<?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>
<signature></signature>
</request>| Название | Тип | Значение | Примечание |
|---|---|---|---|
| fromDate | DateTime | начало периода | |
| toDate | DateTime | конец периода | |
| pageCurrent | int | текущая страница | |
| pageSize | int | размер запрашиваемой странице | не может превышать 50 |
| sort | enum: {asc,desc} | сортировка списка | необязательный параметр, по умолчанию desc |
| signature | string(32) | подпись |
Ответ:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<actions count="count" totalCounr="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>