ПланФикс API action.getListByPeriod — различия между версиями
Материал из ПланФикс
Alice (обсуждение | вклад) |
Artem (обсуждение | вклад) |
||
| (не показаны 2 промежуточные версии этого же участника) | |||
| Строка 2: | Строка 2: | ||
|title= ПланФикс API action.getListByPeriod | |title= ПланФикс API action.getListByPeriod | ||
|titlemode=append | |titlemode=append | ||
| − | |keywords=планфикс, | + | |keywords=планфикс, комментарии, апи, api, action.getListByPeriod |
|description= ПланФикс API action.getListByPeriod | |description= ПланФикс API action.getListByPeriod | ||
}} | }} | ||
| − | Получение списка всех | + | Получение списка всех комментариев за заданный период времени: |
<source lang="xml"> | <source lang="xml"> | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
| Строка 36: | Строка 36: | ||
| sort||enum: {asc,desc} || сортировка списка || необязательный параметр, по умолчанию desc | | sort||enum: {asc,desc} || сортировка списка || необязательный параметр, по умолчанию desc | ||
|- | |- | ||
| − | | task.id||int || идентификатор задачи || необязательный параметр, по умолчанию выбираются | + | | task.id||int || идентификатор задачи || необязательный параметр, по умолчанию выбираются комментарии по всем задачам |
|- | |- | ||
| signature||string(32) ||подпись || | | signature||string(32) ||подпись || | ||
| Строка 56: | Строка 56: | ||
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание | !width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание | ||
|- | |- | ||
| − | |'''actions ''' || ||корневой узел содержащий список | + | |'''actions ''' || ||корневой узел содержащий список комментариев || |
|- | |- | ||
| − | |'''actions ''' count|| int||количество | + | |'''actions ''' count|| int||количество комментариев в ответе || |
|- | |- | ||
| − | |'''actions ''' totalCount||int || количество | + | |'''actions ''' totalCount||int || количество комментариев, удовлетворяющих запросу || |
|- | |- | ||
| − | |action || || | + | |action || || комментарий, описание параметра смотри в разделе [[ПланФикс API action.get| Получить комментарий]] || |
|- | |- | ||
|} | |} | ||
| Строка 74: | Строка 74: | ||
</response> | </response> | ||
</source> | </source> | ||
| − | |||
== Перейти == | == Перейти == | ||
| − | *[[ПланФикс API: | + | *[[ПланФикс API:Комментарии]] |
*[[Коды ошибок]] | *[[Коды ошибок]] | ||
*[[Список функций]] | *[[Список функций]] | ||
Текущая версия на 08:24, 31 мая 2021
Получение списка всех комментариев за заданный период времени:
<?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 | комментарий, описание параметра смотри в разделе Получить комментарий |
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>