ПланФикс API file.get: различия между версиями
Материал из Planfix
SliZzzZ (обсуждение | вклад) |
Seva (обсуждение | вклад) Нет описания правки |
||
Строка 7: | Строка 7: | ||
<file> | <file> | ||
<id></id> | <id></id> | ||
<uniqueId></uniqueId> | |||
</file> | </file> | ||
<signature></signature> | <signature></signature> | ||
Строка 15: | Строка 16: | ||
|- | |- | ||
|file.id ||int ||идентификатор файла || | |file.id ||int ||идентификатор файла || | ||
|- | |||
|file.uniqueId ||int ||уникальный идентификатор файла || игнорируется, если задан параметр '''id''' | |||
|- | |- | ||
|signature ||string(32) ||подпись || | |signature ||string(32) ||подпись || | ||
Строка 27: | Строка 30: | ||
<file> | <file> | ||
<id></id> | <id></id> | ||
<uniqueId></uniqueId> | |||
<name></name> | <name></name> | ||
<version></version> | <version></version> | ||
Строка 52: | Строка 56: | ||
|- | |- | ||
|id || int||идентификатор файла || | |id || int||идентификатор файла || | ||
|- | |||
|id || uniqueId||уникальный идентификатор файла идентификатор файла || | |||
|- | |- | ||
|name ||string || имя файла|| | |name ||string || имя файла|| |
Версия от 15:23, 14 декабря 2010
Функция получения информации о файле. Формат запроса:
<?xml version="1.0" encoding="UTF-8"?>
<request method="file.get">
<account></account>
<sid></sid>
<file>
<id></id>
<uniqueId></uniqueId>
</file>
<signature></signature>
</request>
Название | Тип | Значение | Примечание |
---|---|---|---|
file.id | int | идентификатор файла | |
file.uniqueId | int | уникальный идентификатор файла | игнорируется, если задан параметр id |
signature | string(32) | подпись |
Результат выполнения функции:
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<file>
<id></id>
<uniqueId></uniqueId>
<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 | идентификатор файла | |
id | uniqueId | уникальный идентификатор файла идентификатор файла | |
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>