ПланФикс API: Работа с файлами
Материал из Planfix
file.download / скачать файл
(!Под вопросом). Позволяет скачать файл.
<?xml version="1.0" encoding="UTF-8"?>
<request method="file.download">
<account><!-- имя аккаунта --></account>
<sid><!-- ключ сессии, полученный после аутентификации --></sid>
<file>
<id></id>
</file>
<signature></signature>
</request>
Ответом будет не стандартный пакет в формате XML а прямой файл. Поэтому надо будет парсить HTTP-ответ. Типа 200 - все ок, 403 - доступ к файлу жапрещен, 404 - фалй не найден.
file.getListForProject / список файлов
Получение списка файлов для проекта.
<?xml version="1.0" encoding="UTF-8"?>
<request method="file.getListForProject">
<account><!-- имя аккаунта --></account>
<sid><!-- ключ сессии, полученный после аутентификации --></sid>
<project>
<id></id>
</project>
<fileGroup></fileGroup>
<pageCurrent></pageCurrent>
<pageSize></pageSize>
<signature></signature>
</request>
Параметр fileGroup - не обязательный.
Ответ:
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<files count="x" totalCount="x">
<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>
</file>
<file>
<!-- ... -->
</file>
<!-- ... -->
</files>
</response>
Формат такого ответа получают все запросы на список файлов.
Константы
Типы файлов
- FILESYSTEM - обычный файл
- INTERNET - внешний файл, хранящийся на внешнем ресурсе.