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

Материал из ПланФикс
Перейти к: навигация, поиск
 
(не показано 7 промежуточных версий 3 участников)
Строка 1: Строка 1:
−
Получение списка всех действий за заданный период времени:
+
{{#seo:
 +
|title= ПланФикс API action.getListByPeriod
 +
|titlemode=append
 +
|keywords=планфикс, комментарии, апи, 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"?>
Строка 10: Строка 17:
 
   <pageSize></pageSize>
 
   <pageSize></pageSize>
 
   <sort></sort>
 
   <sort></sort>
 +
  <task>
 +
    <id></id>
 +
  </task>
 
   <signature></signature>
 
   <signature></signature>
 
</request>
 
</request>
Строка 22: Строка 32:
 
| pageCurrent||int || текущая страница ||
 
| pageCurrent||int || текущая страница ||
 
|-
 
|-
−
| pageSize||int || размер запрашиваемой странице || не может превышать 50
+
| pageSize||int || размер запрашиваемой страницы || не может превышать 100
 
|-
 
|-
 
| sort||enum: {asc,desc} || сортировка списка || необязательный параметр, по умолчанию desc
 
| sort||enum: {asc,desc} || сортировка списка || необязательный параметр, по умолчанию desc
 +
|-
 +
| task.id||int || идентификатор задачи || необязательный параметр, по умолчанию выбираются комментарии по всем задачам
 
|-
 
|-
 
| signature||string(32) ||подпись ||
 
| signature||string(32) ||подпись ||
Строка 34: Строка 46:
 
<?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>
Строка 44: Строка 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 || || действие. описание параметра смотри в разделе [[ПланФикс API action.get|action.get / Получить действие]] ||
+
|action || || комментарий, описание параметра смотри в разделе [[ПланФикс API action.get| Получить комментарий]] ||
 
|-
 
|-
 
|}
 
|}
Строка 62: Строка 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>


Перейти

Источник — «http://planfix.ru/wiki/index.php?title=ПланФикс_API_action.getListByPeriod&oldid=33208»