ПланФикс API action.getListWithAnalitic: различия между версиями
Материал из Planfix
								
												
				Seva (обсуждение | вклад) Нет описания правки  | 
				Artem (обсуждение | вклад)  Нет описания правки  | 
				||
| (не показаны 4 промежуточные версии 2 участников) | |||
| Строка 2: | Строка 2: | ||
|title=ПланФикс API action.getListWithAnalitic  | |title=ПланФикс API action.getListWithAnalitic  | ||
|titlemode=append  | |titlemode=append  | ||
|keywords=планфикс, апи, api  | |keywords=планфикс, апи, api, action.getListWithAnalitic  | ||
|description=Получение списка   | |description=Получение списка комментариев с указанной аналитикой  | ||
}}  | }}  | ||
Получение списка комментариев с указанной аналитикой:  | |||
Получение списка   | |||
<source lang="xml">  | <source lang="xml">  | ||
<?xml version="1.0" encoding="UTF-8"?>  | <?xml version="1.0" encoding="UTF-8"?>  | ||
| Строка 15: | Строка 14: | ||
     <id></id>  |      <id></id>  | ||
   </analitic>  |    </analitic>  | ||
   <  |    <task>  | ||
    <id></id>  | |||
  </task>  | |||
   <pageCurrent></pageCurrent>  |    <pageCurrent></pageCurrent>  | ||
   <pageSize></pageSize>  |    <pageSize></pageSize>  | ||
| Строка 24: | Строка 25: | ||
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание    | !width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание    | ||
|-  | |-  | ||
|analitic.id ||int || идентификатор аналитики|| список аналитик можно получить с помощью [[ПланФикс API analitic.getList|  | |analitic.id ||int || идентификатор аналитики|| список аналитик можно получить с помощью [[ПланФикс API analitic.getList| списка доступных аналитик в ПланФикс ]]  | ||
|-  | |-  | ||
|   | | task.id ||int || если задано значение, то происходит выборка комментариев только из этой задачи || необязательный параметр  | ||
|-  | |-  | ||
|-  | |-  | ||
| Строка 51: | Строка 52: | ||
!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| Получить комментарий]] ||  | ||
|-  | |-  | ||
|}  | |}  | ||
| Строка 69: | Строка 70: | ||
</response>  | </response>  | ||
</source>  | </source>  | ||
== Перейти ==  | == Перейти ==  | ||
*[[ПланФикс API:  | *[[ПланФикс API:Комментарии]]  | ||
*[[Коды ошибок]]  | *[[Коды ошибок]]  | ||
*[[Список функций]]  | *[[Список функций]]  | ||
Текущая версия от 08:29, 31 мая 2021
Получение списка комментариев с указанной аналитикой:
<?xml version="1.0" encoding="UTF-8"?>
<request method="action.getListWithAnalitic">
  <account></account>
  <sid></sid>
  <analitic>
    <id></id>
  </analitic>
  <task>
    <id></id>
  </task>
  <pageCurrent></pageCurrent>
  <pageSize></pageSize>
  <signature></signature>
</request>| Название | Тип | Значение | Примечание | 
|---|---|---|---|
| analitic.id | int | идентификатор аналитики | список аналитик можно получить с помощью списка доступных аналитик в ПланФикс | 
| task.id | int | если задано значение, то происходит выборка комментариев только из этой задачи | необязательный параметр | 
| pageCurrent | int | текущая страница | |
| pageSize | int | размер запрашиваемой страницы | не может превышать 100 | 
| 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>