ПланФикс API action.getList — различия между версиями
Материал из ПланФикс
Alice (обсуждение | вклад) |
Artem (обсуждение | вклад) |
||
| (не показаны 4 промежуточные версии 2 участников) | |||
| Строка 1: | Строка 1: | ||
| − | Получение списка | + | {{#seo: |
| + | |title=ПланФикс API action.getList | ||
| + | |titlemode=append | ||
| + | |keywords=планфикс, комментарии, апи, api, action.getList | ||
| + | |description=Получение списка комментариев в задаче | ||
| + | }} | ||
| + | |||
| + | Получение списка комментариев в задаче: | ||
<source lang="xml"> | <source lang="xml"> | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
| Строка 21: | Строка 28: | ||
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание | !width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание | ||
|- | |- | ||
| − | |task (contact) || ||задача/контакт, из которого получаем | + | |task (contact) || ||задача/контакт, из которого получаем комментарии — должен присутствовать только один узел (или task или contact) || |
|- | |- | ||
|task.id ||int ||идентификатор задачи || | |task.id ||int ||идентификатор задачи || | ||
| Строка 53: | Строка 60: | ||
!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| Получить комментарий]] || |
|- | |- | ||
|} | |} | ||
| Строка 71: | Строка 78: | ||
</response> | </response> | ||
</source> | </source> | ||
| − | |||
== Перейти == | == Перейти == | ||
| − | *[[ПланФикс API: | + | *[[ПланФикс API:Комментарии]] |
*[[Коды ошибок]] | *[[Коды ошибок]] | ||
*[[Список функций]] | *[[Список функций]] | ||
Текущая версия на 08:22, 31 мая 2021
Получение списка комментариев в задаче:
<?xml version="1.0" encoding="UTF-8"?>
<request method="action.getList">
<account></account>
<sid></sid>
<task>
<id></id>
<general></general>
</task>
<contact>
<general></general>
</contact>
<pageCurrent></pageCurrent>
<pageSize></pageSize>
<sort></sort>
<signature></signature>
</request>| Название | Тип | Значение | Примечание |
|---|---|---|---|
| task (contact) | задача/контакт, из которого получаем комментарии — должен присутствовать только один узел (или task или contact) | ||
| task.id | int | идентификатор задачи | |
| task.general | int | номер задачи (если задан, используется вместо id) | |
| contact.general | int | номер контакта | |
| pageCurrent | int | текущая страница | |
| pageSize | int | размер запрашиваемой страницы | не может превышать 100 |
| sort | enum: {asc,desc} | сортировка списка | необязательный параметр, по умолчанию desc |
| 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>