ПланФикс API action.getListByPeriod: различия между версиями
Материал из Planfix
								
												
				Seva (обсуждение | вклад) Нет описания правки  | 
				Seva (обсуждение | вклад)  Нет описания правки  | 
				||
| Строка 10: | Строка 10: | ||
   <pageSize></pageSize>  |    <pageSize></pageSize>  | ||
   <sort></sort>  |    <sort></sort>  | ||
  <task>  | |||
    <id></id>  | |||
  </task>  | |||
   <signature></signature>  |    <signature></signature>  | ||
</request>  | </request>  | ||
| Строка 25: | Строка 28: | ||
|-  | |-  | ||
| sort||enum: {asc,desc} || сортировка списка || необязательный параметр, по умолчанию desc  | | sort||enum: {asc,desc} || сортировка списка || необязательный параметр, по умолчанию desc  | ||
|-  | |||
| task.id||int || идентификатор задачи || необязательный параметр, по умолчанию выбираются действия по всем задачам  | |||
|-  | |-  | ||
| signature||string(32) ||подпись ||  | | signature||string(32) ||подпись ||  | ||
Версия от 13:44, 2 февраля 2016
Получение списка всех действий за заданный период времени:
<?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 | размер запрашиваемой странице | не может превышать 50 | 
| sort | enum: {asc,desc} | сортировка списка | необязательный параметр, по умолчанию desc | 
| task.id | int | идентификатор задачи | необязательный параметр, по умолчанию выбираются действия по всем задачам | 
| signature | string(32) | подпись | 
Ответ:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <actions count="count" totalCounr="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>