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

Материал из Planfix
Перейти к: навигация, поиск
Нет описания правки
Нет описания правки
 
(не показано 11 промежуточных версий 4 участников)
Строка 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"?>
Строка 7: Строка 14:
   <task>
   <task>
     <id></id>
     <id></id>
    <general></general>
   </task>
   </task>
  <contact>
    <general></general>
  </contact>
   <pageCurrent></pageCurrent>
   <pageCurrent></pageCurrent>
   <pageSize></pageSize>
   <pageSize></pageSize>
  <sort></sort>
   <signature></signature>
   <signature></signature>
</request>
</request>
Строка 16: Строка 28:
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание  
|-
|-
|task.id ||int || идентификатор задачи||
|task (contact) || ||задача/контакт, из которого получаем комментарии — должен присутствовать только один узел (или task или contact) ||
|-
|task.id ||int ||идентификатор задачи ||
|-
|task.general||int ||номер задачи (если задан, используется вместо id)||
|-
|contact.general||int ||номер контакта ||
|-
|-
| pageCurrent||int || текущая страница ||
| pageCurrent||int || текущая страница ||
|-
|-
| pageSize||int || размер запрашиваемой странице || не может превышать 50
| pageSize||int || размер запрашиваемой страницы || не может превышать 100
|-
| sort||enum: {asc,desc} || сортировка списка || необязательный параметр, по умолчанию desc
|-
|-
| signature||string(32) ||подпись ||
| signature||string(32) ||подпись ||
Строка 30: Строка 50:
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<response status="ok">
   <actions count="count" totalCounr="totalCount">
   <actions count="count" totalCount="totalCount">
     <action><!-- ... --></action>
     <action><!-- ... --></action>
     <action><!-- ... --></action>
     <action><!-- ... --></action>
Строка 40: Строка 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 || || действие. описание параметра смотри в разделе [[ПланФикс API action.get|action.get / Получить действие]] ||
|action || || комментарий, описание параметра смотри в разделе [[ПланФикс API action.get| Получить комментарий]] ||
|-
|-
|}
|}
Строка 58: Строка 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>


Перейти

Источник — http://planfix.com/ru/help/index.php?title=ПланФикс_API_action.getList&oldid=33206