ПланФикс API file.get: различия между версиями
Материал из Planfix
Seva (обсуждение | вклад) (Новая страница: «Функция получения информации о файле. Формат запроса: <source lang="xml"> <?xml version="1.0" encoding="UTF-8"?> <reques...») |
Seva (обсуждение | вклад) Нет описания правки |
||
| Строка 48: | Строка 48: | ||
</response> | </response> | ||
</source> | </source> | ||
{| class="wikitable" style="margin-top: 1em; width:100% " | |||
!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание | |||
|- | |||
|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||имя пользователя || | |||
|- | |||
|} | |||
В противном случае будет возвращен ответ с ошибкой: | В противном случае будет возвращен ответ с ошибкой: | ||
Версия от 14:18, 25 августа 2010
Функция получения информации о файле. Формат запроса:
<?xml version="1.0" encoding="UTF-8"?>
<request method="file.get">
<account></account>
<sid></sid>
<file>
<id></id>
</file>
<signature></signature>
</request>| Название | Тип | Значение | Примечание |
|---|---|---|---|
| file.id | int | идентификатор файла | |
| signature | string(32) | подпись |
Результат выполнения функции:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<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>
</response>| Название | Тип | Значение | Примечание |
|---|---|---|---|
| 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 | имя пользователя |
В противном случае будет возвращен ответ с ошибкой:
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code></code>
</response>| Значение code | Расшифровка |
|---|---|
| 0000 | неизвестная ошибка |