Просмотр исходного текста страницы ПланФикс API file.getListForProject

Функция получения списка файлов для проектов. Формат запроса:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request method="file.getListForProject">
  <account></account>
  <sid></sid>
  <project>
    <id></id>
  </project>
  <pageCurrent></pageCurrent>
  <pageSize></pageSize>
  <returnDownloadLinks></returnDownloadLinks>
  <signature></signature>
</request>
</source>
{| class="wikitable" style="margin-top: 1em; width:100% "
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание 
|-
|project.id ||int ||идентификатор проекта ||
|-

|pageCurrent ||int ||текущая страница ||нумерация с 1. 0 - используется для получения количества 
|-
|pageSize ||int ||размер запрашиваемой страницы ||
|-
|returnDownloadLinks ||bool ||возвращать ли в ответе постоянные ссылки для скачивания файла || значение по-умолчанию 0
|-
|signature ||string(32) ||подпись ||
|-
|}

Результат выполнения функции:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <files count="count" totalCount="totalCount">
    <file>
      <id></id>
      <name></name>
      <version></version>
      <description></description>
      <date></date>
      <sourceType></sourceType>
      <size></size>
      <task>
        <id></id>
        <title></title>
      </task>
      <project>
        <id></id>
        <title></title>
      </project>
      <user>
        <id></id>
        <name></name>
      </user>
      <downloadLink></downloadLink>
    </file>
    <file>
      <!-- ... -->
    </file>
    <!-- ... -->
  </files>
</response>
</source>
{| class="wikitable" style="margin-top: 1em; width:100% "
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание 
|-
|'''files''' || || ||
|-
|'''files''' count ||int ||количество возвращенных запросом файлов ||
|-
|'''files''' totalCount ||int || количество файлов удовлетворяющих запросу ||
|-
|file || ||узел описывающий файл ||
|-
|id || int||идентификатор файла ||
|-
|name ||string || имя файла||
|-
|version ||int || версия||
|-
|description ||string ||описание ||
|-
|date ||DateTime ||дата загрузки файла ||
|-
|sourceType ||enum ||типы файлов ||список допустимых значений смотри в [[ПланФикс API:Типы файлов|типы файлов]]
|-
|size ||int ||размер в килобайтах ||
|-
|task || || в рамках какой задачи был залит ||
|-
|task.id ||int || идентификатор задачи ||
|-
|task.title ||string ||название задачи ||
|-
|project || ||в рамках какого проекта был загружен файл ||
|-
|project.id || int||идентификатор проекта ||
|-
|project.title || string||название проекта ||
|-
|user || ||пользователь, который загрузил файл ||
|-
|user.id ||int ||идентификатор пользователя ||
|-
|user.name || string||имя пользователя ||
|-
|downloadLink || string||ссылка для скачивания файла ||
|-
|}


В противном случае будет возвращен ответ с ошибкой:
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>
</source>



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