ПланФикс API action.getList: различия между версиями

Материал из Planfix
Перейти к: навигация, поиск
Нет описания правки
Нет описания правки
Строка 82: Строка 82:


== Перейти ==
== Перейти ==
*[[ПланФикс API:Действия]]
*[[ПланФикс API: Комментарии]]
*[[Коды ошибок]]
*[[Коды ошибок]]
*[[Список функций]]
*[[Список функций]]

Версия от 10:32, 18 февраля 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 действие. описание параметра смотри в разделе action.get / Получить действие


В противном случае будет возвращен ответ с ошибкой:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>


Перейти