ПланФикс API file.getListForProject — различия между версиями
Материал из ПланФикс
Lesya (обсуждение | вклад) |
Seva (обсуждение | вклад) |
||
| (не показаны 2 промежуточные версии этого же участника) | |||
| Строка 8: | Строка 8: | ||
<id></id> | <id></id> | ||
</project> | </project> | ||
| − | |||
<pageCurrent></pageCurrent> | <pageCurrent></pageCurrent> | ||
<pageSize></pageSize> | <pageSize></pageSize> | ||
| + | <returnDownloadLinks></returnDownloadLinks> | ||
<signature></signature> | <signature></signature> | ||
</request> | </request> | ||
| Строка 19: | Строка 19: | ||
|project.id ||int ||идентификатор проекта || | |project.id ||int ||идентификатор проекта || | ||
|- | |- | ||
| − | | | + | |
| + | |pageCurrent ||int ||текущая страница ||нумерация с 1. 0 - используется для получения количества | ||
|- | |- | ||
| − | | | + | |pageSize ||int ||размер запрашиваемой страницы || |
|- | |- | ||
| − | | | + | |returnDownloadLinks ||bool ||возвращать ли в ответе постоянные ссылки для скачивания файла || значение по-умолчанию 0 |
|- | |- | ||
|signature ||string(32) ||подпись || | |signature ||string(32) ||подпись || | ||
| Строка 54: | Строка 55: | ||
<name></name> | <name></name> | ||
</user> | </user> | ||
| + | <downloadLink></downloadLink> | ||
</file> | </file> | ||
<file> | <file> | ||
| Строка 104: | Строка 106: | ||
|- | |- | ||
|user.name || string||имя пользователя || | |user.name || string||имя пользователя || | ||
| + | |- | ||
| + | |downloadLink || string||ссылка для скачивания файла || | ||
|- | |- | ||
|} | |} | ||
Текущая версия на 08:41, 29 ноября 2019
Функция получения списка файлов для проектов. Формат запроса:
<?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>| Название | Тип | Значение | Примечание |
|---|---|---|---|
| project.id | int | идентификатор проекта | |
| pageCurrent | int | текущая страница | нумерация с 1. 0 - используется для получения количества |
| pageSize | int | размер запрашиваемой страницы | |
| returnDownloadLinks | bool | возвращать ли в ответе постоянные ссылки для скачивания файла | значение по-умолчанию 0 |
| signature | string(32) | подпись |
Результат выполнения функции:
<?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>| Название | Тип | Значение | Примечание |
|---|---|---|---|
| files | |||
| files count | int | количество возвращенных запросом файлов | |
| files totalCount | int | количество файлов удовлетворяющих запросу | |
| file | узел описывающий файл | ||
| id | int | идентификатор файла | |
| name | string | имя файла | |
| version | int | версия | |
| description | string | описание | |
| date | DateTime | дата загрузки файла | |
| sourceType | enum | типы файлов | список допустимых значений смотри в типы файлов |
| 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 | ссылка для скачивания файла |
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>